List the customer group metrics

GET

https://payment-retry.apps.zuora.com/api/v1/metrics/customer_group

GET

/api/v1/metrics/customer_group

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.configurable_payment_retry.get_customer_group_metrics()

200Retrieved

{
  "customer_groups": [
    {
      "average_attempts": "4.11",
      "document_success_rate": "17.17",
      "document_success_rate_trend": "up",
      "id": 1,
      "name": "batch22",
      "retry_success_rate": "21.76",
      "smart_retry": false
    },
    {
      "average_attempts": "1.32",
      "document_success_rate": "74.17",
      "document_success_rate_trend": "down",
      "id": 2,
      "name": "Smart Retry",
      "retry_success_rate": "81.21",
      "smart_retry": true
    },
    {
      "average_attempts": "3.32",
      "document_success_rate": "16.35",
      "document_success_rate_trend": "up",
      "id": 4,
      "name": "All Remaining Customers",
      "retry_success_rate": "15.21",
      "smart_retry": false
    }
  ],
  "success": true
}

Gets the following metrics for each customer group that is in the active status:

Document Success Rate and trend
Retry Success Rate
Average Attempts

Authentication

AuthorizationBasic

The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.

Response

customer_groupslist of objectsOptional

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

successbooleanOptional

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.