---
title: "List the customer group metrics"
method: GET
path: "/api/v1/metrics/customer_group"
tags: ["Configurable Payment Retry"]
---

# List the customer group metrics

`GET /api/v1/metrics/customer_group`

Gets the following metrics for each customer group that is in the active status:
  - Document Success Rate and trend
  - Retry Success Rate
  - Average Attempts

## Response `200`

- GETCustomerGroupMetricsResponse
  - `customer_groups` object[] — An array containing the following information for each customer group. - Customer group ID - Customer group name - Whether Smart Retry is enabled for this customer group - Document Success Rate indicating the percentage of billing documents that are successfully collected - The trend of change in Document Success Rate over the last 30 days - Retry Success Rate indicating the percentage of the successful payment attempts - Average Attempts indicating the average number of attempts required to recover funds
  - `success` boolean — Indicates whether the metrics are retrieved successfully. If no data is loaded yet, a 200 response code will be returned with the success field set to `true`. All expected fields will be present but the value will be `null`.

---

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