Get Report Runs

Beta

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

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

Search through previously executed report runs.

This endpoint is paginated. See Pagination for how to page through the results.

Request

curl -X GET 'https://app.untetherlabs.com/api/v1/reporting/reports/runs' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY'

Response 200

{
  "items": [
    {
      "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
      }
    }
  ],
  "cursor": "string"
}

Query parameters#

statusReportStatus[]· default ["running","completed","failed"]

running
completed
failed

useruuid

Filter to only runs generated by this user

reportstring

pageSizenumber· default 20 · min 1 · max 200

cursorstring

Response 200#

itemsReportRun[]

Required

Show ReportRun properties

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

cursorstring

Errors#

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required