Create Report Run

Beta

posthttps://app.untetherlabs.com/api/v1/reporting/reports/runs

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.

Request

curl -X POST 'https://app.untetherlabs.com/api/v1/reporting/reports/runs' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY' \
  -H 'Content-Type: application/json' \
  -d @body.json

body.json

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

Response 201

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

Request body#

reportIdstring

Required

parametersobject

Show values

<key>any

Response 201#

reportIdstring

Required

createdAtstring

Required

createdByReportUser

Required

namestring

Required

statusReportStatus

Required

running
completed
failed

fileobject

Only present if the report has been completed.

namestring

Required

mediaTypestring

Required

sizeBytesnumber· min 0

Required

Errors#

report-parameter-validation400

A report parameter did not pass validation, see message.

Show extension members

pathstring

messagestring

Required

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required

report-not-found404

A specified report does not exist in the system.

user-not-found404

A specified user does not exist in the system.