---
title: "List report runs"
method: GET
path: "/api/v1/report-runs"
tags: ["Reports"]
---

# List report runs

`GET /api/v1/report-runs`

List report runs

## Query parameters

- `report` string
- `type` 'objectStorage' | 'stripe' | 'webhook' — The type of the report.
- `limit` integer
- `from` string, date-time
- `to` string, date-time

## Response `200`

The request has succeeded.

- ReportRun[]
  - `from` string, date-time, required — The start of the period the report run covers.
  - `id` string, required — The ID of the report run.
  - `reportId` string, required — The ID of the report.
  - `stats` ReportRunStats, required — The stats of the report run.
    - `completed` integer, required — The number of tasks succesfully completed.
    - `failed` integer, required — The number of tasks failed.
    - `skipped` integer, required — The number of tasks skipped. Tasks can be skipped for example when OpenMeter is missing information to perform the task in the external system. Like missing Stripe customer ID.
    - `total` integer, required — The total number of tasks.
  - `time` string, date-time, required — The time the report run was created.
  - `to` string, date-time, required — The end of the period the report run covers.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `403` — The server understood the request but refuses to authorize it.
- `412` — One or more conditions given in the request header fields evaluated to false when tested on the server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `503` — The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
- `default` — An unexpected error response.

---

[API](https://skmtc.dev/openmeter/apis/openmeter-cloud-api.md) · [All operations](https://skmtc.dev/openmeter/apis/openmeter-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openmeter/openmeter-cloud-api/revisions/c9c0ec9cffe9/schema)