Skip to main content
POST
/
v1
/
reporting
/
reports
/
runs
Create Report Run
curl --request POST \
  --url https://app.untetherlabs.com/api/v1/reporting/reports/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportId": "payroll-report",
  "parameters": {
    "startDate": "2025-01-01",
    "endDate": "2025-01-31"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reportId": "payroll-report",
  "createdAt": "2024-11-20T07:43:34+0000",
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Bruce Wayne"
  },
  "status": "running",
  "file": {
    "name": "payroll-2025-01-01.csv",
    "mediaType": "text/csv",
    "sizeBytes": 1
  }
}
This is a beta endpoint. Breaking changes may occur without notice, use at your own risk.
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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
reportId
string
required
Example:

"payroll-report"

​
parameters
object
Example:
{
  "startDate": "2025-01-01",
  "endDate": "2025-01-31"
}

Response

​
id
string<uuid>
required
​
reportId
string
required
Example:

"payroll-report"

​
createdAt
string
required
Example:

"2024-11-20T07:43:34+0000"

​
createdBy
object
required
​
status
enum<string>
required
Available options:
running,
completed,
failed
​
file
object

Only present if the report has been completed.