Skip to main content
POST
Create report

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
name
string
required

Name of the report. Maximum 255 characters. Example: Monthly delivery report

Maximum string length: 255
fields
string[]
required

Columns of the report, at least one, no duplicates. Each value must be a component id of the chosen flow (task report) or a field id of the chosen data type (data report). Example: ["title", "assignee", "status"]

inputType
string

The input type of the component (e.g., string, number, date, etc.)

flowId
string

Flow whose tasks the report reads. Required when type is task. Must be a 24-character id of a flow in your organization. Example: 64e5b1c2d3e4f5a6b7c8d9e0

dataTypeId
string

Data type whose records the report reads. Required when type is data. Must be a 24-character id of a data type in your organization. Example: 64f0a1b2c3d4e5f6a7b8c9d0

hubIds
string[]

Hubs the report covers. Required for task reports and for data types that are not common data; ignored (saved as empty) for common data types. Every id must be a distinct hub of your organization. Example: ["64d9932e2beb9037735ff022"]

defaultFilters
object

Starting filters when the report is run. Task reports only; ignored for data reports. When omitted, a task report gets {"datePreset": "monthly", "status": [], "assignee": []}.

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

Created report configuration.