Get Report Run

Beta

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

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

Retrieve metadata about a specific report run, including a temporary download link if the report has been completed.

The download link will expire after one hour, at the given expiresAt time.

Request

curl -X GET 'https://app.untetherlabs.com/api/v1/reporting/reports/runs/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -H 'Authorization: Bearer $UNTETHER_API_KEY'

Response 200

{
  "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
  },
  "download": {
    "url": "https://example.com",
    "expiresAt": "2024-11-20T07:43:34+0000"
  }
}

Path parameters#

reportRunIduuid

Required

Response 200#

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

downloadReportDownload

urluri

Required

expiresAtstring

Required

Errors#

validation400

Input validation failed.

Show extension members

pathstring

messagestring

Required

report-run-not-found404

A specified report run does not exist in the system.