Sign in
reports

Create Digest

Create a digest. Requires can_create_reports since a digest is effectively a scheduled deliverable — same gate as a schedule.

post/api/v1/reports/digests

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring required
cronstring required
timezonestring
formatstring
report_idsinteger[] required
recipient_user_idsinteger[]

Response

Successful Response

idinteger required
namestring required
owner_idinteger required
schedule_cronstring required
timezonestring required
formatstring required
report_idsinteger[] required
recipient_user_idsinteger[] required
is_activeboolean required
next_run_atstring date-time nullable
last_run_atstring date-time nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 5 revisions of this API.