Skip to main content
GET
Get AI Traffic Analytics

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Required for session auth. API keys already belong to one organization.

Maximum string length: 160
from
string

First day of the range (YYYY-MM-DD). Defaults to 29 days before to.

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

Last day of the range, inclusive (YYYY-MM-DD). Defaults to today.

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

IANA time zone that defines each day, for example Asia/Kuala_Lumpur. Defaults to Asia/Singapore.

Maximum string length: 80
source
string

One AI source id from data.filterOptions.sources.

Maximum string length: 120
trafficType
enum<string>
Available options:
indexing,
click_through,
page_view,
assistant
route
string

One route key from data.filterOptions.routes.

Maximum string length: 120
country
string

ISO country code of the visit.

Maximum string length: 8

Response

Get AI Traffic Analytics

ok
boolean
required
apiVersion
string
required
Allowed value: "developer_v1"
operationId
string
required
status
enum<string>
required
Available options:
accepted,
completed,
failed
warnings
string[]
required
recommendations
string[]
required
data
object
required
jobId
string
productId
string