Saltar al contenido

reportSchedules

Módulo Reports · 5 operaciones

List report schedule rows

GET/report-schedules

A scheduled email delivery of a report to org members only. Returns a cursor page of report schedule rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a report schedule

POST/report-schedules

A scheduled email delivery of a report to org members only. Creates a report schedule. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a report schedule

GET/report-schedules/{id}

A scheduled email delivery of a report to org members only. Returns one report schedule with its `ETag`. A report schedule the caller may not see returns 404.

Update a report schedule

PATCH/report-schedules/{id}

A scheduled email delivery of a report to org members only. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a report schedule

DELETE/report-schedules/{id}

A scheduled email delivery of a report to org members only. Soft-deletes the report schedule: it moves to Trash and can be restored for its table's retention period.