API reference
Every route of the v2 API, generated from apps/api/openapi.json and grouped by tag.
Ingest
Send events from browsers and servers
Sign-in
GitHub sign-in through Better Auth and the current session
Projects
Projects, their visibility and keys
Tokens
API tokens for scripts and CI
Reads
Aggregate reads for one project
Headline numbers
One metric over time
Top values of a dimension
The last five minutes
Where visitors went next
Returning visitors by cohort
New, returning, resurrected and dormant visitors
Visitors by days active
Weekday and hour heatmap
Visitors per place
Live events
Visitor-level reads
Events, visitors and sessions at the detail level
Raw events
Visitors
One visitor
Mark a visitor as internal
A visitor's visits
Sessions
One session's events
All projects
The same reads across every readable project
Raw events across projects
Headline numbers across projects
One metric over time across projects
One row per project
Top values of a dimension across projects
The last five minutes across projects
Visitors across projects
Sessions across projects
Identified people
One person across projects
Where visitors went next, across projects
Returning visitors by cohort, across projects
Visitor lifecycle across projects
Visitors by days active, across projects
Weekday and hour heatmap across projects
Visitors per place across projects
Live events across projects
Speed across projects
One metric per day across projects
Speed per route across projects
Elements behind slow values across projects
Issues across projects
Speed
Core Web Vitals and the Real Experience Score
Issues
Error tracking, issues and error rules
Issues
One issue
Resolve, ignore or reopen an issue
An issue's events
Error rules
Add an error rule
Remove an error rule
Annotations
Dated labels on a project's time series
Dev widget
The admin dev widget: bootstrap, live visitors and sessions, logs, overview
Alerts
Alert targets, deliveries and their status
Alert targets
Sync alert targets
Remove an alert target
Set one alert target
Test an alert target
Rotate a webhook secret
Alert deliveries
Alerts status
SQL
The read-only SQL console and saved queries
Run SQL on one project
Run SQL across projects
Estimate a query's cost
The queryable views
Latest query runs
Saved queries
Save a query
One saved query
Change a saved query
Delete a saved query
Jobs
Scheduled jobs and operations metrics
Roll up speed
Delete expired rows
Queue and send alerts
Compare speed with the Chrome UX Report
Operations metrics
System
Health and documentation