Skip to main content
POST
Create a report

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Body

application/json

Create/update body. digestTime and digestTimezone are required when mode is scheduled.

name
string
required
Maximum string length: 80
outcomes
string[]
required
Minimum array length: 1
mode
enum<string>
required
Available options:
scheduled,
instant
recipients
string<email>[]
digestTime
string
Example:

"06:00"

digestTimezone
string
Example:

"Asia/Kolkata"

digestWindowHours
integer
default:24
Required range: 1 <= x <= 168

Response

The created report.

A named call summary. instant delivers the moment a call reaches one of outcomes; scheduled sends one daily digest at digestTime over the last digestWindowHours. Delivery is by email (to recipients) and, when the tenant has a webhook URL, also as a report.instant / report.digest webhook event — so a report with no recipients is a valid webhook-only one.

id
string<uuid>
name
string

Unique within the workspace.

outcomes
string[]

Outcome keys this report covers (the stable id, not the display name).

mode
enum<string>
Available options:
scheduled,
instant
recipients
string<email>[]

Emails this report sends to. May be empty (webhook-only).

digestTime
string | null

HH:MM 24-hour; scheduled only.

digestTimezone
string | null

IANA zone; scheduled only.

digestWindowHours
integer

1–168; scheduled only.

createdAt
string<date-time>
updatedAt
string<date-time>