Get competitor sentiment comparison
Changed onHead-to-head sentiment comparison of the brand vs competitors — sentiment score and positive/neutral/negative share per entity. Pass unbranded=true or branded=true to filter by prompt brand state. days defaults to 30, max 365. limit defaults to 10, max 50.
Request
- Base URLhttps://app.searchable.com
- AuthHTTP bearer
Path parameters
The project id.
Query parameters
Lookback window in days. Default and maximum vary by endpoint — see the operation description.
Comma-separated AI platform filter (e.g. chatgpt,claude,gemini). Accepted values and whether the param is required vary by endpoint — see the operation description.
Pass true to restrict every metric to non-branded prompts only.
Pass true to restrict every metric to branded prompts only.
Return only one kind of competitor, as split in the app's Competitors list: direct competitors are the ones you track on purpose, serp competitors were found in AI answers (a competitor never marked either way counts as serp). all (the default) returns both. This narrows which competitor rows come back, not how they are measured: share of voice, visibility and rank stay calculated against every brand and competitor in the market, and the brand's own figures are unchanged.
Comma-separated ISO 3166-1 country codes (e.g. US,GB) or country names.
Comma-separated tracked-location ids.
Page size. Defaults and caps vary by endpoint (see each operation's description); big list endpoints (cited domains/URLs, prompts, opportunities) cap at 1000, issues at 5000. Values above an endpoint's cap are clamped server-side, never rejected.
Start of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires to, and is mutually exclusive with days — sending both returns 400 invalid_argument. A range longer than the endpoint's maximum is rejected rather than clamped.
End of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires from.
Response
Competitor sentiment comparison.
Changes
- warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
duplicate_scopeenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
host_outside_domainenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
idempotency_conflictenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_citation_typeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
invalid_scopeenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
missing_competitorenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
rule_limitenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
security_policy_deniedenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - warning
added the new
unknown_competitorenum value to theresponse property for the response status - info
added the new optional
queryrequest parametercompetitorType - info
added the new optional
queryrequest parameterfrom - info
added the new optional
queryrequest parameterto - info
added the optional property
//to the response with the status
- warning