Skip to main content
POST
Schedule a saved report for recurring delivery

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
report_id
integer
required

Source Report id. Validation: required. 404 when not found.

Example:

88

duration
integer
required

Reporting window length (interpretation owned by the scheduler). Validation: required.

Example:

30

frequency
enum<integer>
required

Delivery cadence code: 0 daily, 1 weekly, 2 monthly, 3 quarterly, 4 semiannual, 5 annual, 6 once, or 14 biweekly. Validation: required.

Available options:
0,
1,
2,
3,
4,
5,
6,
14
Example:

1

start_date
string<date>
required

First scheduled run date. Validation: required.

Example:

"2026-05-01"

Response

Schedule created.

message
string
Example:

"Report scheduled successfully"