Sign in

v4

Swagger 2.0Proprietary2026-08-0173264.4 KB
Answers

List AI responses

Pass query for case-insensitive full-text search inside response texts: total becomes the exact match count and items return snippet + match_count instead of response.

get/answers

Query parameters

project_idinteger required

Project ID

model'chatgpt' | 'perplexity' | 'gemini' | 'ai_overview' | 'ai_mode' | 'copilot' | 'claude' | 'grok' | 'deepseek' | 'meta_ai' | 'amazon_rufus'

Filter by AI model. Models the API key's user has not enabled are silently dropped.

collection_idinteger
country_codestring
language_codestring
promptinteger
fromstring date-time
tostring date-time
pageinteger
per_pageinteger
mention_filter'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands'

Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors). The four combined cells are you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor and no_brands (no tracked brand appears). Combine with competitors to narrow the competitor side; on a negative cell that reads none of these. On /dimensions/sources it applies to the crawled content of each cited page. The legacy value competitors_only is accepted as an alias of competitor_not_you.

citation_filter'cites_you' | 'not_cites_you' | 'cites_competitor' | 'not_cites_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'cites_no_brands'

The same two-axis matrix applied to the domains cited in the answer. Independent of mention_filter; pass both to intersect them.

competitorsstring

Comma-separated competitor IDs

querystring

Case-insensitive full-text search inside AI response texts.

Response

Paginated answers