---
title: "Get payment analytics"
method: GET
path: "/api/analytics/payments"
tags: ["Analytics"]
---

# Get payment analytics

`GET /api/analytics/payments`

Retrieve payment metrics including success rate, failure rate, total volume, and breakdown by payment provider.

## Query parameters

- `dateFrom` string
- `dateTo` string
- `currency` string
- `groupBy` 'day' | 'week' | 'month'
- `provider` string

## Response `200`

Payment metrics and provider breakdown

- PaymentAnalyticsResponse
  - `totalPayments` number, required
  - `succeeded` number, required
  - `failed` number, required
  - `pending` number, required
  - `successRate` string, required — Success rate percentage

---

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