Skip to main content
GET
Get AI agent traffic overview for a brand report

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

startDate
string

Optional. Start of the window (inclusive), YYYY-MM-DD. Omit it to get the 13 days before endDate; omit both dates for the last 14 days (UTC), matching the dashboard.

Example:

"2026-08-07"

endDate
string

Optional. End of the window (inclusive), YYYY-MM-DD. Defaults to today (UTC).

Example:

"2026-08-20"

engine
enum<string>

Optional. Restrict results to a single engine. Omit for all engines. Pass other to match every AI crawler outside the named engines.

Available options:
chatgpt,
claude,
copilot,
perplexity,
google,
other
Example:

"chatgpt"

Response

Agent traffic overview for the brand report.

availability
enum<string>
required

Whether these numbers can be trusted. not_connected means no logs connector is active for this report — metrics are null, NOT zero, because nothing is being measured. connected_no_data means a connector is active but matched no visits in this window, so the zeros are real. connected_with_data means the payload is populated.

Available options:
not_connected,
connected_no_data,
connected_with_data
Example:

"connected_with_data"

startDate
string
required

Start of the resolved window (inclusive), YYYY-MM-DD.

endDate
string
required

End of the resolved window (inclusive), YYYY-MM-DD.

domains
string[]
required

The report's own domains the query spanned — its main domain plus its domain variations. Normalized (lowercased, www. and port stripped).

totalAgentVisits
integer | null
required

Total AI agent visits in the window. null when availability is not_connected.

Required range: x >= 0
pagesVisited
integer | null
required

Distinct pages visited in the window. null when availability is not_connected.

Required range: x >= 0
topEngine
enum<string> | null
required

Engine with the most visits in the window; null when there were none.

Available options:
chatgpt,
claude,
copilot,
perplexity,
google,
other,
null
Example:

"chatgpt"

engines
object[]
required

Window totals per engine, highest first. Empty when there is no data.

trend
object[]
required

Per-(day, engine, bot) visit series for the window. engine is the folded public id (same vocabulary as engines/topEngine); bot is the raw crawler name, so one engine can span several bots on a day.