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

Query Parameters

window
enum<string>

A named window ending today in the project's market, or custom with from and to. Default 30d.

Available options:
7d,
30d,
90d,
180d,
365d,
custom
from
string

First day, inclusive. Required with window=custom.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Last day, inclusive. Required with window=custom.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

OK

project_id
string<uuid>
required

The project asked about.

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)$
state
enum<string>
required
Available options:
connected,
syncing,
low_coverage,
not_connected,
auth_expired
window
string
required

The window in words, e.g. last 30 days.

from
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
property
string | null
required
ai_sessions
number
required
sessions_from_sampled_engines
number
required
matched
number
required
unmatched
number
required
conversions
number
required
conversion_label
string
required
value_cents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
coverage
object
required

Matched sessions over every AI session. No band: both are counts.

coverage_note
string | null
required
by_referrer
object[]
required
by_page
object[]
required
by_prompt
object[]
required
custom_prompts
object[]
required

Your branded and comparison prompts, kept out of the headline.

unmatched_classes
object[]
required
method
string
required
engines_sampled
string[]
required