Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.

FlowAuthorization Code
Authorization URL
/oauth/authorize
Token URL
/oauth/token
Refresh URL
/oauth/token
Scopes1
analytics:read
Read Search Console and AI traffic analytics.

Path Parameters

profile_id
string<uuid>
required

Profile UUID; must be in the grant allowlist and currently accessible to the actor.

Query Parameters

start
string<date>
required

Inclusive start date (YYYY-MM-DD).

end
string<date>
required

Inclusive end date (YYYY-MM-DD), not before start, at most today (UTC); the range is at most the configured maximum (486 days by default).

filter
enum<string>
default:popular
Available options:
popular,
growing,
decaying,
lost
source
enum<string>
default:all

AI assistant source; all returns the per-source breakdown.

Available options:
all,
gemini,
perplexity,
chatgpt,
claude,
grok
sort_by
enum<string>
default:total
Available options:
total,
gemini,
perplexity,
chatgpt,
claude,
grok,
variation,
users
sort_order
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:50

List size from 1 to the configured maximum (100); an out-of-range or malformed value returns invalid_limit.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of ranked items to skip.

Required range: x >= 0

Response

Pages visited from AI assistants, paged by offset.

data
object
required
meta
object
required