---
title: "List the document success rate metrics by customer group"
method: GET
path: "/api/v1/metrics/customer_group_over_time"
tags: ["Configurable Payment Retry"]
---

# List the document success rate metrics by customer group

`GET /api/v1/metrics/customer_group_over_time`

Gets the Document Success Rate timeseries for each customer group over the past 6 months. The data of the current month will not be included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown.

## Response `200`

- GETDocumentSuccessRateByCustomerGroupResponse
  - `customer_groups` object[] — An array containing the Document Success Rate timeseries for each customer group represented by the customer group ID. A timeseries over the past 6 months is present in the format of `<month_year>: <document_success_rate>`. The data of the current month is not included. For example, if it is April 15th today, the data for April will not be included. Data for March and earlier will be shown.
  - `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)