Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key from Workspace settings → API keys, sent as Authorization: Bearer <key>.

Path Parameters

projectId
string
required
key
string
required

Query Parameters

window
enum<string>
Available options:
7d,
30d,
90d,
180d,
365d,
custom
from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
Pattern: ^\d{4}-\d{2}-\d{2}$
engines
string
brand_id
string<uuid>

The project's own brand (the default) or a tracked competitor.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

OK

key
string
required
label
string
required
polarity
enum<string>
required
Available options:
positive,
negative,
neutral
dimension
enum<string> | null
required
Available options:
ease_of_use,
features,
fit,
integrations,
pricing,
support,
trust,
scale,
other
brand
object
required
sources
object[]
required
sources_more
boolean
required