Skip to main content
POST
Create a report

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string

Client-provided idempotency key that prevents duplicate report creation

Body

application/json

Report input

filters
object
required

Filter conditions grouped by data source, table, and field.

Example:
templateId
string
required

Template identifier used to generate the report.

Example:

"00000000-0000-0000-0000-000000000000"

Response

Created

completedAt
string<date-time> | null

Time when report generation completed, when available.

Example:

"2026-01-31T15:04:05Z"

createdAt
string<date-time>

Time when the report was created.

Example:

"2026-01-31T15:00:00Z"

deletedAt
string<date-time> | null

Time when the report was soft-deleted, when applicable.

Example:

"2026-02-01T09:00:00Z"

filters
object

Filter conditions grouped by data source, table, and field.

Example:
id
string

Stable report identifier.

Example:

"00000000-0000-0000-0000-000000000001"

metadata
object

Additional report metadata keyed by attribute name.

Example:
status
string

Current report generation status.

Example:

"Processing"

templateDescription
string

Description copied from the template when the report was created.

Example:

"Monthly accounting report"

templateId
string

Template snapshot source identifier.

Example:

"00000000-0000-0000-0000-000000000002"

templateOutputFormat
string

Output format selected for the generated report.

Example:

"pdf"

updatedAt
string<date-time>

Time when the report was last updated.

Example:

"2026-01-31T15:04:05Z"