---
title: "Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction_summary table for stats"
method: GET
path: "/v1/report/performance-report"
tags: ["Reports"]
---

# Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction_summary table for stats

`GET /v1/report/performance-report`

## Query parameters

- `from_date` string
- `to_date` string
- `state` 'UNDEFINED' | 'STARTED' | 'CAPTURABLE' | 'FAILED_REJECTED' | 'FAILED_EXPIRED' | 'FAILED_CANCELLED' | 'CANCELLED' | 'CREATED' | 'SUBMITTED' | 'SUCCESS' | 'ERROR' | 'ERROR_GATEWAY' | 'NEEDS_RESPONSE' | 'UNDER_REVIEW' | 'LOST' | 'WON'

## Response `200`

OK

- PerformanceReportEntity
  - `average_amount` number
  - `total_amount` number
  - `total_volume` integer

## Other responses

- `400` — For missing query params or invalid state).
- `500` — Internal Server Error for invalid query params (from_date/to_date) values

## Changes

- **2025-01-16** `ef12d134c115` — 1 warning
  - added the new `AMOUNT_BELOW_MINIMUM` enum value to the `error_identifier` response property for the response status `400`
- **2024-11-25** `6a7b3b19bd40` — 1 warning
  - added the new `NON_HTTPS_RETURN_URL_NOT_ALLOWED_FOR_A_LIVE_ACCOUNT` enum value to the `error_identifier` response property for the response status `400`
- **2023-07-06** `8563b7d75ea6` — 1 warning
  - added the new `CARD_NUMBER_IN_PAYMENT_LINK_REFERENCE_REJECTED` enum value to the `error_identifier` response property for the response status `400`
- **2023-03-15** `d06cd3b61b6c` — 1 warning
  - added the new `IDEMPOTENCY_KEY_USED` enum value to the `error_identifier` response property for the response status `400`
- **2023-01-05** `fdbb87a0f0b3` — 1 warning
  - added the new `RECURRING_CARD_PAYMENTS_NOT_ALLOWED` enum value to the `error_identifier` response property for the response status `400`

[Full history](https://skmtc.dev/government-digital-service/apis/ledger-api/changes/v1/report/performance-report/get.md)

---

[API](https://skmtc.dev/government-digital-service/apis/ledger-api.md) · [All operations](https://skmtc.dev/government-digital-service/apis/ledger-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/government-digital-service/ledger-api/revisions/10ffeffca918/schema)