Creating a report allows your organization to programmatically retrieve information that's available in our dashboard UI.
This request creates a new report object with a unique ID, and kicks off an async report generation.
To retrieve a completed report, either poll /api/v2/reports/{id} or listen for REPORTS webhook event.
Pass timezone to interpret date filters and render timestamps in a specific time zone. Reports created through the API default to UTC and never use your organization's dashboard time zone.
Request body
| Property | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
report_type
| string | Type of report for retrieval.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
format
| string | Format the report will be generated in.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timezone
| string | Time zone used to interpret date filters and display timestamps in the generated report. Accepts IANA time zone identifiers such as America/New_York or Europe/London, and UTC. Aliases such as US/Eastern are accepted and normalized to their canonical identifier (America/New_York). Defaults to UTC when omitted, null, or blank. Reports created through the API do not inherit your organization's dashboard time zone. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filters
| object | Filters to apply to the report. Corresponds to the filters provided in the dashboard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Show object properties
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate limits
Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you'll receive a 429 response.