Skip to main content
GET
Advertisers

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>

Ads are tracked on ChatGPT only, so this is chatgpt or omitted.

Available options:
chatgpt
from
string<date>

Inclusive start date. Defaults to 30 days before to.

to
string<date>

Exclusive end date. Defaults to tomorrow.

country
string

Restrict to one market: a two-letter code, or global for checks run without a market. The summary's markets lists the values this brand has.

topic_id
string<uuid>[]

Repeatable. Restrict to prompts in these topics.

branding
enum<string>
default:all

Restrict to prompts that name this brand (branded) or to those that do not (non_branded). Omit, or all, for every prompt.

Available options:
all,
branded,
non_branded
tracked
boolean

true = only tracked competitors. rank and share_pct stay overall.

Match advertiser name, key or domain.

Maximum string length: 200
limit
integer
default:100

Rows per page. Max 500.

Required range: x <= 500
cursor
string

Opaque cursor from the previous page's next_cursor. Use it with the same other parameters.

Response

Success

data
object[]
required
has_more
boolean
next_cursor
string | null

Pass back as cursor. Null when there are no more rows.

total_count
integer

How many rows match in total, across all pages.