get_visibility_setup | None | Brand name, domain and variants, tracked competitors and categories (with IDs), the collection schedule, and the AI platforms your plan collects from. |
get_visibility_overview | range | Workspace-wide mention rate, citation rate and share of voice with deltas, plus daily trends. This is the best place to start for “how are we doing”. |
get_visibility_by_platform | range | Snapshots, mention and citation rate per platform (ChatGPT, Gemini, Perplexity, Claude, Grok, Google AI Overview). |
get_visibility_by_category | range | Mention and citation rates per prompt category, plus an uncategorised row. |
get_competitor_leaderboard | range | Every competitor with mention rate, citation rate and share of voice, and where you rank on each. Each row carries competitor_id (null on your own row). |
get_competitor | competitor_id, range | One competitor in depth: rates, prompt coverage, trend, citations by platform, top cited pages. |
get_competitor_pages | competitor_id, range, search?, url? | Every page of theirs that AI cites, ordered by citations. With url, one page’s citation rate, share, trends and the prompts citing it. |
get_cited_sources | range, type (domain | url), limit (≤50) | The domains or URLs cited most across all your prompts, tagged as yours, a competitor’s or neither. |
list_cited_pages | range, search?, sort, order, page, per_page (≤100) | Your own pages that AI cites: citations, citation rate, share and unique prompts. |
get_cited_page | url (as listed, with or without https://), range | One of your pages: rates, share, trends and the prompts that cite it. |
list_prompts | range, search?, category_id?, sort, order, page, per_page (≤100) | Tracked prompts with mention and citation rates. Returns prompt IDs. sort by created_at, category, mention_rate or citation_rate. |
get_prompt_analytics | prompt_id, range | One prompt: rates and trends, per-platform results, competitors mentioned. |
get_prompt_answers | prompt_id, range, platform?, date? (YYYY-MM-DD), full | The answers AI platforms gave, newest first, up to 200. With full=true, the answer text, citations, brand mention excerpts and detected competitors. |