Get Report Run

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

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.

get/v1/reporting/reports/runs/{reportRunId}

Request

  • Base URL
    https://app.untetherlabs.com/api
  • URL
    https://app.untetherlabs.com/api/v1/reporting/reports/runs/{reportRunId}
  • Auth
    HTTP bearer

Path parameters

reportRunIdstring uuid required

Response

idstring uuid required
reportIdstring required
createdAtstring required
status'running' | 'completed' | 'failed' required

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.