Compute insights
Computes up to 20 of the built-in insights (revenue, MRR, churn, trials, persons, retention and more) over a time range, each with an optional filter, breakdown and granularity.
Each result carries the caller's key and the absolute time range it covered. A monetary insight reports in the organization's reporting currency (USD until one is chosen in its settings), names it in summary.currency, and gives its amounts in integer minor units of it, such as cents. A secret key reports its own environment's events and revenue; a person's own credentials choose with x-environment: production (the default), test or all.
Guide: Analytics overview
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | unknown_insight | With a message saying what to change. |
| 400 | invalid_request | unsupported_filter | With a message saying what to change. |
| 400 | invalid_request | unsupported_breakdown | With a message saying what to change. |
| 400 | invalid_request | invalid_time_range | With a message saying what to change. |
| 400 | invalid_request | invalid_report_request | With a message saying what to change. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Analytics
- Compute charts
POST - Measure metrics
POST - List the people behind a metric
POST - Report acquisition
POST - Report acquisition cohorts
POST - Report tracking health
POST - List live users
POST
Something wrong or missing on this page? Tell us by email or on Discord.