Skip to main content
GET
Get AI-referral session timeseries

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
platform
string

AI platform filter. One of openai, anthropic, google, perplexity, microsoft (bots/referrals additionally accept deepseek, xai, meta). Required on top-cited-pages; a comma-separated list is accepted where noted.

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"

Response

AI-referral session timeseries.

points
object[]
required
totals
object
required
dateRange
object
required

The resolved lookback window for this response.