Skip to main content
GET
Get AI traffic overview

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Query Parameters

days
integer

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

Required range: x >= 1
from
string

Start of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires to, and is mutually exclusive with days — sending both returns 400 invalid_argument. A range longer than the endpoint's maximum is rejected rather than clamped.

Example:

"2026-03-01"

to
string

End of an absolute window (inclusive, UTC). Accepts YYYY-MM-DD or a full ISO timestamp. Requires from.

Example:

"2026-03-31"

host
string

Comma-separated hostnames to narrow the report to. Useful on multi-domain projects; omit for every host in the project.

Example:

"blog.acme.com"

groupBy
enum<string>

Optional crawler-breakdown dimension on traffic overview, bots, and correlation. Omit for the legacy response. platform requests byPlatform, botCategory adds byCategory, and botName adds byBot. Overview and bots retain their existing byPlatform array. These rows classify crawl requests only; AI-referral sessions are not attributed to a crawler. Unknown values return 400 invalid_argument.

Available options:
platform,
botCategory,
botName

Response

Traffic overview.

crawlers
object
required
referrals
object
required
topPages
object[]
required

Top 10 crawl-ranked pages. referrals is always null here — call top-cited-pages with a platform for per-page AI-referral counts.

dateRange
object
required

The resolved lookback window for this response.

groupBy
enum<string>

Present when the request selected a crawler grouping.

Available options:
platform,
botCategory,
botName