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
reportId
string
required

Response

OK

report
object
required
project_name
string | null
required
scope
object | null
required

What the numbers cover: the window and its dates, the engines, the segments, the prompts and answers counted, and a sentence saying so. Shown beside every figure.

state
enum<string> | null
required

empty: no prompts in scope and no answers in the window.

Available options:
empty,
populated
metrics
object | null
required
rank
object | null
required

Your rank by visibility among the brands named. Null when your brand has no row.

engines
object[]
required
digest
object | null
required

Null when nothing was measured.

trend
object | null
required
losing_prompts
object[]
required
league
object[]
required