---
title: "Get a report"
method: GET
path: "/v1/reports/{report-id}"
tags: ["Reports"]
---

# Get a report

`GET /v1/reports/{report-id}`

Here, you apply the `report-id` from the [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation as the path parameter to get a `downloadlink` containing the report.

Download the report at the link in the `downloadLink` field in the response.

## Path parameters

- `report-id` string, uuid, required

## Response `200`

Returns the JSON record of the report specified in the path parameter

- ReportDownloadRecordLink
  - `reportId` string, uuid, required — Unique identifier for a report.
  - `reportName` string — User defined name of the report.
  - `reportType` 'PAYMENT_OPS' | 'RECON' | 'FAILURE_CONVERSION_SSA', required — The report type of the downloadable report.
  - `reportFormat` 'CSV' | 'JSON', required — The report format of the downloadable report.
  - `reportStatus` 'PENDING' | 'READY' | 'FAILED' | 'EMPTY', required — The status of the report.
  - `startDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) for a requested report.
  - `endDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) for a requested report. **Note**: Must be after `startDate`, but no more than 90 days after.
  - `createdOn` string, date-time — Report creation time
  - `downloadLink` string, uri — Link where you can download the report in the available format. This field is available when the report `status` is `READY`.
  - `reportCreatedBy` string — Identifies the entity that initiated the report creation. | Value | Description | |-------------|----------------------------------------------------| | SCHEDULER | Automated system-generated report initiated by the scheduler. | | API | User-generated report initiated through the API. | | [full name] | Full name of the user who initiated the creation of the report through the UI. | | null | Legacy support for older reports. |

## Other responses

- `400` — Bad request
- `403` — Forbidden
- `404` — Not found

---

[API](https://skmtc.net/ripple/apis/report-service-api.md) · [All operations](https://skmtc.net/ripple/apis/report-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/report-service-api/revisions/54de4d3166be/schema)