Skip to main content
POST
Create custom report

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
type
enum<string>

Report type. Must be raw.

Available options:
raw
recipients
string<email>[]

Report recipients will receive link to CSV file with generated report.

Report recipient email address

range
object

Report time range

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

name
string

The report name.

settings
object
integrations
object

The external integrations data.