Changelog
The stats API moves to api.highseat.com
- Developers
curl https://api.highseat.com/v1/sites/example.com/pages?limit=5 \ -H "Authorization: Bearer hs_live_…"
The stats API now has a host of its own. Every endpoint sits under https://api.highseat.com/v1, and every call is a read: a GET that answers JSON.
Create a key in Workspace settings, API keys. A key reads every site in the workspace, sites added later included, or only the ones you pick, and it belongs to the workspace, so it keeps working when the member who made it leaves.
What you can read
Each site answers on its domain or its id. Ask for the overview figures, a time series, or a breakdown of pages, sources, devices, locations, campaigns, bots, events, goals or revenue. Realtime and funnels have endpoints too.
A breakdown pages with a cursor. Pass the nextCursor of one answer as cursor to get the next, up to 500 rows a page. A key can make 600 calls an hour, and every answer says how many are left in its RateLimit headers.
The spec is at https://api.highseat.com/v1/openapi.json, and an agent can read https://api.highseat.com/v1/llms.txt.
Improvements
- A new API key shows the base URL beside it, ready to copy.
GET /v1/usagereports the workspace's events this period, its plan's limit and the projection to the end of the period, and it answers even while the workspace is locked.- The docs have an API Reference tab with a page for every endpoint, generated from the OpenAPI spec, and a playground that sends real requests.
Fixes
- The old
/api/v1paths on the dashboard's own origin are gone. Point every call athttps://api.highseat.com/v1.