Schedules

List the scheduled deliveries

Returns the scheduled deliveries of the account, or of one report when report_key is sent. A schedule at frequency none is kept and listed: it is a configured delivery that is stopped. A one-off delivery that has been asked for and not sent yet is not listed at all, and neither is the request of a snapshot: the key of a queued snapshot is the schedule_key /v1/reports/take-snapshot answered, which 409 ALREADY_QUEUED repeats, and /v1/schedules/delete accepts it even though nothing lists it. Two kinds of schedule this version cannot express are still listed and say so: uses_system_template and conditional_execution_enabled mark the ones /v1/schedules/update refuses to change.

post/schedules/list

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/schedules/list
  • Auth: HTTP bearer

Request body

report_keystring

Only the schedules of this report. When absent, every schedule of the account.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.