Skip to main content
GET
Get user 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"

source

Optional. Keep only visits from these sources: an AI service (openai, perplexity, google, microsoft, anthropic, …), other_external (another website), direct_none (no referrer) or internal_self (another page of the site). Repeat the param for several, up to 50. Omitted, it means the AI assistants only, as in the app. Naming sources replaces that set: source=direct_none returns direct visits alone; repeat the param to mix AI and non-AI sources.

Required string length: 1 - 50
country

Optional. Keep only visits from these countries: ISO 3166-1 alpha-2 codes as the countries endpoint lists them (us, de; uk for the United Kingdom; zz for the visits whose country is unknown). Repeat the param for several. Omit for all countries.

Response

User 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, normalized (lowercased, www. and port stripped).

totalVisits
integer | null
required

Page views 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
uniqueVisitors
integer | null
required

Distinct visitors in the window (a visitor who returns on another day counts once; browsers that block storage are not counted). null when availability is not_connected, when the window starts more than about 13 months back (the raw events behind the count are kept 13 months), or when the count ran out of time. Narrow the window rather than retry.

Required range: x >= 0
topSource
string | null
required

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

Example:

"openai"

sources
object[]
required

Window totals per source, highest first.

trend
object[]
required

Per-(day, source) visit series for the window.