Traffic

Google Analytics landing pages, acquisition and measurement health, and CDN crawler traffic, error paths and firewall rules.

These endpoints read the Google Analytics and Cloudflare data pulled into a workspace. They need the search scope, and every one takes a required workspace_id query parameter. from and to are YYYY-MM-DD.

Landing pages

GET /v1/traffic/landing?workspace_id={id}

Google Analytics landing pages for the range by sessions, each with the key events and revenue its organic sessions led to.

Parameter	Notes
`from`, `to`	Defaults to the 28 days up to the latest day with data
`channel`	`all` (default) ranks by sessions from every channel, `organic` by organic search only
`limit`	1 to 500, default 50

Each row has landingPage, sessions, engagedSessions, conversions and totalUsers across channels, and for organic search organicSessions, keyEvents, keyEventRate, eventNames (up to 10), purchases, revenue and revenuePerSession. currency is the property's currency, empty without ecommerce.

Acquisition

GET /v1/traffic/acquisition?workspace_id={id}

Sessions, engaged sessions, key events and revenue for the range by default channel group (channels) and by source and medium (sources), each with its share of all sessions. Takes from, to and limit (1 to 500, default 50).

Measurement health

GET /v1/traffic/health?workspace_id={id}

Whether the Google Analytics data can be trusted over the last 28 days. The response says whether Analytics is connected, gives an overall status (ok, warn, fail or unknown), and lists checks, each with an id, a status and a value:

Check	Value
`data_arriving`	Days since the latest day with data
`key_events`	Key events recorded in the window
`organic_share`	Share of sessions from organic search
`unassigned_share`	Share of sessions with no channel
`landing_match`	How well landing pages match the pages Search Console reports

Crawler traffic

GET /v1/traffic/crawlers?workspace_id={id}

Requests at the edge by day, crawler and response status from the connected CDN (rows), plus the requests each crawler had blocked (blocked). Defaults to the last 7 days. Takes from, to and limit (1 to 500, default 500).

Crawlers are one of googlebot, bingbot, gptbot, oai-searchbot, chatgpt-user, claudebot, perplexitybot, google-extended, applebot, other-bot and human.

Error paths

GET /v1/traffic/paths?workspace_id={id}

Paths that answered at the edge with a given status class, summed over the range, by requests. Defaults to the last 7 days and every user agent.

Parameter	Notes
`from`, `to`	The range
`crawler`	One of the crawlers above, or `all` (default)
`status_class`	`2xx`, `3xx`, `4xx` or `5xx`
`limit`	1 to 500, default 50

Each row has statusClass, the status most requests got, path and requests.

Firewall rules

GET /v1/traffic/firewall?workspace_id={id}

The CDN firewall rules that fired, by crawler, action and source, summed over the range by requests. Defaults to the last 7 days. Takes from, to, crawler and limit (1 to 500, default 50).

Each row has crawler, action (what the CDN did, such as block, challenge, managed_challenge or log), source (which security feature fired), ruleId, ruleDescription and requests.

On this page