Sign in

v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Reports

Create Saved Report

Create a new saved report definition. Saved reports are SQL queries that can be executed later to generate full exports or samples.

If you just want to do ad-hoc queries, you should use the /reports/samples endpoint.

post/print-mail/v1/reports

Request body

sqlQuerystring required

The SQL query defining the report.

descriptionstring

An optional user-friendly description for the report.

metadataobject

Optional key-value metadata associated with the report.

Response

The created Report object.

idstring required

Unique identifier for the report.

object'report' required

Always report.

liveboolean required

Indicates if the report is associated with the live or test environment.

sqlQuerystring required

The SQL query defining the report.

descriptionstring

An optional user-friendly description for the report.

metadataobject

Optional key-value metadata associated with the report.

createdAtstring date-time required

Timestamp when the report was created.

updatedAtstring date-time required

Timestamp when the report was last updated.