Get an analytics report
Returns one visitor analytics report; the report name can contain a slash, as in top/pages. export.csv returns a CSV file and funnel needs steps. A key limited to some apps may only use those.
Requires the deploy:read permission.
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer jb_live_…
Path Parameters
The app name.
1 - 100^[A-Za-z0-9][A-Za-z0-9-]*$The report: stats, timeseries, realtime, events, errors, sessions, web-vitals, retention, funnel, export.csv or top/<dimension> (pages, referrers, countries, devices, browsers, os, languages, timezones, screen-sizes, hostnames, routes, outbound, downloads, utm-sources, utm-campaigns, utm-mediums, utm-terms, utm-contents).
errors, events, export.csv, funnel, realtime, retention, sessions, stats, timeseries, top/browsers, top/countries, top/devices, top/downloads, top/hostnames, top/languages, top/os, top/outbound, top/pages, top/referrers, top/routes, top/screen-sizes, top/timezones, top/utm-campaigns, top/utm-contents, top/utm-mediums, top/utm-sources, top/utm-terms, web-vitals Query Parameters
The time range to report on.
1h, 24h, 7d, 30d, 90d How many rows to return, for list reports.
1 <= x <= 500Event names in order, for the funnel report. Repeat the parameter for each step.
101 - 100Response
The report as JSON, or as CSV for export.csv.
Visitor analytics for the app. The shape depends on the report and comes from the analytics service as it is.