<Warning>This is a beta endpoint. Breaking changes may occur without notice, use at your own risk.</Warning>

Create a new report run for the given report ID.

The report parameters depend on the report being executed, see the report documentation for more info.

Reports are generated asynchronously. The returned object will always be marked as running, you will have to periodically poll for status changes.

{
  "reportId": "payroll-report",
  "parameters": {
    "startDate": "2025-01-01",
    "endDate": "2025-01-31"
  }
}

{
  "reportId": "payroll-report",
  "createdAt": "2024-11-20T07:43:34+0000",
  "createdBy": {
    "name": "Bruce Wayne"
  },
  "file": {
    "name": "payroll-2025-01-01.csv",
    "mediaType": "text/csv"
  }
}