Create a Report
/reportsThis endpoint requests generation of a report. Report generation is asynchronous: the response returns immediately with a pending status, and the report is delivered via the chosen delivery channel once ready. Supply an x-idempotency-key header to safely retry without creating duplicate reports.
Header Parameters
Unique key to make report creation idempotent across retries. Can be any string; we recommend a V4 UUID or another random string with enough entropy to avoid collisions.
Body application/json
The type of report to generate.
Inclusive report start date in ISO 8601 format. Accepts a date (2026-06-01) or a full datetime (2026-06-01T00:00:00Z). A date-only value (no offset) is interpreted as UTC and normalized to the start of that UTC day; a datetime is used with the offset it carries. To use another timezone, include an explicit offset (e.g. 2026-06-01T00:00:00+08:00). The report period is the half-open interval [from_date, to_date).
Exclusive report end date in ISO 8601 format — up to but not including this value. Accepts a date (2026-07-01) or a full datetime (2026-07-01T00:00:00Z). A date-only value (no offset) is interpreted as UTC and normalized to the start of that UTC day; a datetime is used with the offset it carries. To use another timezone, include an explicit offset (e.g. 2026-06-01T00:00:00+08:00). Example: from_date=2026-06-01 with to_date=2026-07-01 covers all of June.
How the completed report is delivered.
Response
Accepted
When the report was delivered via the chosen delivery_channel. Null until delivery has succeeded (a completed report may still have a null sent_at).
Error defines errors may be returned from the system.
Error defines errors may be returned from the system.
Error defines errors may be returned from the system.
Error defines errors may be returned from the system.