Get sentiment summary
Changed onBrand sentiment summary + per-platform distribution (positive/neutral/negative share, sentiment score), with scoreChange against the equal-length window just before the requested one (null when either window has no mentions). Pass unbranded=true or branded=true to filter by prompt brand state, or promptId to narrow everything (the compare window included) to one prompt's answers. analysis and analyses are the project's weekly write-ups and are not narrowed by topicId or promptId. days defaults to 30, max 365.
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.
Restrict to a single topic id.
Restrict to one prompt's answers: the prompt's id, as GET /prompts lists it. A value that is not a UUID is a 400 invalid_argument; an id from another project matches nothing.
Pass true to restrict every metric to non-branded prompts only.
Pass true to restrict every metric to branded prompts only.
Comma-separated ISO 3166-1 country codes (e.g. US,GB) or country names.
Comma-separated tracked-location ids.
Period comparison. previous_period re-runs the same metrics over the window immediately before the current one (same length); previous_year over the same window shifted back exactly 365 days. The response gains an additive comparison block: { mode, dateRange, previous, delta } — delta is current minus previous for every shared numeric metric (on /visibility/topics, per-topic deltas ride inline on each topic row instead). Invalid values return 400 invalid_argument.
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
Sentiment summary.
Changes
- breaking
the response property
/became nullable for the 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
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 parametercompare - info
added the new optional
queryrequest parameterfrom - info
added the new optional
queryrequest parameterpromptId - info
added the new optional
queryrequest parameterto - info
added the optional property
to the response with the status
- breaking