Skip to main content
GET
Get website analytics breakdowns

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Query Parameters

days
integer

Rolling window size in days. Ignored when from/to are set.

Required range: 1 <= x <= 365
from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-31"

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

"2026-01-31"

host
string

Hostname to filter on, such as www.example.com. Subdomains are included. Omit for every host.

Maximum string length: 128
path
string

Only count this exact page path, such as /pricing.

Maximum string length: 2048
sites
enum<string>

exclude leaves out traffic to sites hosted on Notra Sites.

Available options:
exclude

Response

Web analytics breakdowns fetched successfully

configured
boolean
required

False when the analytics backend is not configured for this deployment; the payload is then empty rather than an error.

pages
object[]
required
sources
object[]
required
countries
object[]
required

ISO 3166-1 alpha-2 country codes.

devices
object[]
required
outcomes
object[]
required

How sessions from AI assistants behave compared to others.

Clicks on links to other sites.

vitals
object[]
required

Core Web Vitals from real visits.

errors
object[]
required

JavaScript errors reported by notra.plus.js.

languages
object[]
required
organization
object
required
imported
object | null

Latest completed history import. Days up to until come from it; native tracking starts the day after.