Skip to main content
GET
Your brand versus its competitors

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer gp_live_....

Path Parameters

id
string<uuid>
required

Brand id.

Query Parameters

engine
enum<string>

Restrict to one engine. Omit for the all-engine rollup. Stable public engine identifier. Internal model names are never exposed.

Available options:
chatgpt,
claude,
perplexity,
gemini,
google_ai_overviews,
google_ai_mode,
copilot
from
string<date>

Inclusive start date. Defaults to 30 days before to.

to
string<date>

Exclusive end date. Defaults to tomorrow.

limit
integer
default:100

How many rows to return. This grain does not page: it is a complete set and limit truncates it, so check capped before treating the response as all of them.

Required range: x <= 999

Response

Success

data
object[]
required
has_more
boolean

Always false: this grain does not page.

next_cursor
string | null

Always null: this grain does not page.

total_count
integer

How many rows matched in total, before limit.

capped
boolean

True when total_count exceeds the rows returned, so this is a truncated set and not all of them.