Skip to main content
POST
Create a scheduled analytics report

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required
Required string length: 1 - 120
type
enum<string>
required
Available options:
messaging_volume,
deliverability,
top_contacts,
spend,
custom
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
recipients
required

1–50 unique recipient emails, as an array or a comma-separated string.

filters
object | null

Optional saved-query definition; filters.dataset must name a known dataset when present.

enabled
boolean
default:true
timezone
string

IANA zone name, e.g. America/New_York.

Response

201 - application/json

The created scheduled report.

data
object
meta
object