API metrics
This document provides definitions and details of various API metrics, including usage, failures, performance, and concurrency limits.
The following table provides definitions of the API metrics.
Metric | Description |
|---|---|
API Usage | The number of API requests issued within a specified time range, and details of each of the requests.
Note that the Track ID column displays the values specified in the |
API Failures | All the failed API requests issued within the specified time range. Besides the detailed information of the failed requests, you can also view the response code and response body of each of the failed request. Note that some API failures might not be instantly picked up by the notification system because the notification system allows for a custom polling interval. It can cause a temporary discrepancy between the notification record and the API System Health dashboard. The impact of such a discrepancy should be minimal, and it will be auto-rectified over time. |
API Performance | The response time data of the API requests within a specified time range. Available metrics include the following:
|
API Concurrency Limit | The concurrency limits data for the Default and High-volume transactions concurrency limit types within a specified time range.
Note that the Tracing Identifier column displays prefixes of the values specified in the |
Note that you can configure notifications based on the API Failures, API Performance, or API Concurrency metrics. For more information, see Standard events for Zuora Central Platform.
Use the Summary pane to get an overview of the data.The Summary pane displays a summary of the selected data. For example, on the Overview tab, Summary displays the following metrics of the selected API requests:
- Total number of requests that are issued.
- Number of successful requests
- Number of errored requests
- Error rate
The API data for requests not issued to standard Zuora API endpoints are unavailable in the API dashboard.