Skip to main content
GET
Brand visibility

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Brand id.

Query Parameters

from
string<date>

Inclusive start date. Defaults to 30 days before to.

to
string<date>

Exclusive end date. Defaults to tomorrow.

engine
enum<string>[]

Repeatable. 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
topic_id
string<uuid>[]

Repeatable. Restrict to prompts in these topics.

prompt_id
string<uuid>

Restrict to a single prompt. Not repeatable, and cannot be combined with topic_id. For metrics across many prompts use GET /v1/brands/{id}/prompts?include=metrics.

Set false for the summary only.

compare
boolean
default:false

Adds the previous equal-length period and deltas.

Response

Success

data
object
required