Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
reports

Get Report Schedule Runs

Use this endpoint to get a list of instances for a scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a Not Found error. If the scheduled report requested hasn'run yet the response will be an Empty response.

get/reports/scheduled-reports/{scheduledReportId}/runs

Path parameters

scheduledReportIdstring uuid required

The scheduled report's unique identifier

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
pageStartIndexinteger

The index of the page to return

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "reportId": "db672560-00f0-405d-af6e-8d0aa17a94df",
      "date": "2022-06-22T19:47:10Z",
      "runInstanceId": "be6f252d-5aa6-49e3-a2e2-470a67f88711",
      "recipientsCount": 100
    }
  ]
}