Skip to main content
POST
Create report

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
title
string
required

Report title (required)

Required string length: 1 - 500
companyId
string<uuid>
required

Company ID (required)

reportTypeId
string<uuid>
required

Report type ID (required)

dateStart
string
required

Report date range start (YYYY-MM-DD)

dateEnd
string
required

Report date range end (YYYY-MM-DD)

description
string

Report description

Maximum string length: 2000
reportTemplateId
string<uuid>

Template to base report on

reportStructure
object

Report content structure

status
enum<string>

Report status (default: draft)

Available options:
draft,
published

Response

Report created successfully

data
object
required