API docs v1

API reference / Resource

Scheduled reports

CRUD for scheduled report definitions. Each schedule fires a new report at the configured frequency (daily/weekly/monthly).

12 endpoints

  1. GET /v1/scheduled-reports List scheduled reports
  2. POST /v1/scheduled-reports Create a scheduled report
  3. GET /v1/scheduled-reports/{scheduled_report_id} Retrieve a scheduled report
  4. PATCH /v1/scheduled-reports/{scheduled_report_id} Update a scheduled report
  5. DELETE /v1/scheduled-reports/{scheduled_report_id} Delete a scheduled report
  6. GET /v1/scheduled-reports/{scheduled_report_id}/analytics Schedule analytics
  7. POST /v1/scheduled-reports/{scheduled_report_id}/duplicates Duplicate a scheduled report
  8. POST /v1/scheduled-reports/{scheduled_report_id}/executions Run schedule now
  9. GET /v1/scheduled-reports/{scheduled_report_id}/prompt-history/{region_config_prompt_id} Prompt run history
  10. GET /v1/scheduled-reports/{scheduled_report_id}/region-configs List attached region configs
  11. POST /v1/scheduled-reports/{scheduled_report_id}/region-configs/{region_config_id} Attach a region config
  12. GET /v1/scheduled-reports/{scheduled_report_id}/runs List schedule runs