Skip to main content
GET
Read sentiment overview

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Query Parameters

windowDays
integer
allTime
boolean
platform
enum<string>
Available options:
all,
chatgpt,
gemini,
perplexity,
claude,
ai_mode,
ai_overview
region
string
groupId
integer
brandScope
enum<string>
Available options:
all,
workspace_brand,
competitor,
other_brand
competitorId
integer
sentiment
enum<string>
Available options:
all,
positive,
negative,
neutral,
mixed
brandsSortKey
enum<string>
Available options:
brand,
targetKind,
mentions,
positive,
negative,
mixed,
netSentiment,
averageRank
brandsSortDirection
enum<string>
Available options:
asc,
desc
evidenceSortKey
enum<string>
Available options:
occurredAt,
quote,
brand,
sentiment,
aspect,
prompt,
model,
region
evidenceSortDirection
enum<string>
Available options:
asc,
desc
evidenceAspect
string
Minimum string length: 1
Minimum string length: 1
seriesGranularity
enum<string>
Available options:
day,
week,
month
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string
Maximum string length: 4096

Response

Requested workspace data. Empty or missing-source states are returned explicitly.

data
object
required