Single brand summary across the filtered dataset
Returns an AI visibility summary for one brand or competitor name using the supplied scope.
Path parameters
Query parameters
Comma-separated AI platform names, or 'All Platforms' for no filter.
Comma-separated competitor names, or 'All Competitors' for no filter. Keeps prompts where ANY listed competitor appears.
Comma-separated ISO2 country codes, or 'All Countries' for no filter.
YYYY-MM-DD
YYYY-MM-DD
Window length in days, ending today. Defaults to 30.
'branded', 'unbranded', or 'all'.
'tracked', 'untracked', or empty for both.
Comma-separated prompt intents, or empty for all.
Max citing prompts to attach, 0 to omit them, or 'all'. Defaults to 5.
Return each AI answer in full instead of a 500-character preview. Defaults to false.
Changes
Changed in 2 of the 47 revisions of this API.11
- ○
added the new optional
queryrequest parameterincludeResponseTextnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterpromptLimitnew-optional-request-parameter
- ○
- ○
added the new optional
queryrequest parametercompetitornew-optional-request-parameter
- ○
added the new optional
queryrequest parametercountrynew-optional-request-parameter
- ○
added the new optional
queryrequest parameterdaysnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterendDatenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterintentnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterplatformnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterpromptBrandnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterstartDatenew-optional-request-parameter
- ○
added the new optional
queryrequest parametertrackingnew-optional-request-parameter
- ○