Get sentiment summary
Brand sentiment summary + per-platform distribution (positive/neutral/negative share, sentiment score). Pass unbranded=true or branded=true to filter by prompt brand state. days defaults to 30, max 365.
Authorizations
A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.
Path Parameters
The project id.
Query Parameters
Lookback window in days. Default and maximum vary by endpoint — see the operation description.
x >= 1Comma-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.
Pass true to restrict every metric to non-branded prompts only.
true Pass true to restrict every metric to branded prompts only.
true 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.
previous_period, previous_year 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.
"2026-03-01"
End of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires from.
"2026-03-31"