Skip to main content
POST
Create a report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

project_id
string<uuid>
required

Body

application/json

Request body for creating a new report.

name
string
required

Display name for the report.

Required string length: 1 - 255
description
string | null

Optional longer description of the report's purpose.

date_range_start
string<date> | null

Inclusive start date for the report's data range.

date_range_end
string<date> | null

Inclusive end date for the report's data range.

date_range_preset
string | null

Relative date range shortcut. One of '7d', '30d', '90d'. Takes precedence over explicit start/end dates when set.

Response

Successful Response

success
boolean
default:true
data
ReportResponse · object | null

Full report record including all pages and their widgets.