Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
reports

Get Report Instance by ID

Use this endpoint to get a scheduled report instance by it's instance run unique identifier. If the scheduled report requested is not available the response will be a not found error. If the instance of the scheduled report doesn't exists, the response will be a Not Found error

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

Path parameters

scheduledReportIdstring uuid required

The scheduled report's unique identifier

instanceRunIdstring uuid required

The scheduled report's instance run unique identifier

Response

OK

reportIdstring

The unique identifier of the report instance.

datestring date-time

The generation of the report date and time in ISO 8601. https://en.wikipedia.org/wiki/ISO_8601

runInstanceIdstring uuid

The unique identifier of Report Recipient Instance.

recipientsCountinteger

The amount of recipients within the scheduled report instance

Example response

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