Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Report Schedules

Create a report runner

Creates a new report runner definition and schedules it for execution. Returns the persisted report runner with its server-assigned id. The runner begins executing on its first scheduled interval after creation.

post/v7/report-runners

Request body

OR

Example request

{
  "report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
  "sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}"
}

Response

Created report runner.

OR

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "pause_info": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "paused": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
  "sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}",
  "updated_date": "2025-10-24T02:00:00-07:00"
}