---
title: "Get a report run by ID"
method: GET
path: "/analytics/reportRuns/{reportRunId}"
tags: ["ReportRuns"]
---

# Get a report run by ID

`GET /analytics/reportRuns/{reportRunId}`

Get a reportRun by ID.

## Path parameters

- `reportRunId` string, uuid, required

## Response `200`

Success.

- object
  - `id` string, uuid, required — The unique identifier of the report run.
  - `workspaceId` string, uuid — Unique identifier of a workspace in Payrails.
  - `createdAt` string, date-time, required — Time at which the reportRun was created.
  - `report` object
    - `id` string, uuid, required — The unique identifier of the report.
    - `code` string, required — The unique code identifying the report.
    - `name` string, required — Human-readable name of the report.
    - `description` string, required — Description of the report.
  - `parameters` object, required
    - `timezone` string — Defaults to Etc/UTC. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the IANA Time Zone Database.
    - `intervalStart` string, date — The start interval for the report.
    - `intervalEnd` string, date — The end interval for the report.
  - `status` 'pending' | 'successful' | 'failed', required — The status of the report run.
  - `result` object, nullable — If the report run is successful (i.e. status=successful), the details about the generated report file.
    - `fileName` string — The suitable name for saving the file to a filesystem. Containing the directory and the name of the file (without the file extension).
    - `fileType` 'csv' — The returned file type.
    - `url` string — The URL from which to download the file.
    - `expiresAt` string, date-time — The time at which the URL will expire and the file will no longer be accessible.
  - `error` string, nullable — If the report run fails (i.e. status=failed), a message about the failure.
  - `completedAt` string, date-time, nullable — The time at which the report run completes.

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `404` — Not Found.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/revisions/9dd2f0158582/schema)