---
title: "List API volume summary records"
method: GET
path: "/system-health/api-requests/volume-summary"
tags: ["API Health"]
---

# List API volume summary records

`GET /system-health/api-requests/volume-summary`

Returns volume summary of [API](https://docs.zuora.com?resourceId=platform-rest-api) usage that generated by your Zuora tenant within a specified time range.

You can filter the summary by API path name and http method.

## Query parameters

- `path` string
- `httpMethod` string
- `startTime` string, date-time, required
- `endTime` string, date-time, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- GetApiVolumeSummaryResponse
  - `data` ApiVolumeSummaryRecord[] — List of API volume summary records. The records are grouped and ordered by API path name and http method.
    - `api` string — The API path name.
    - `error` integer — The count of failed API requests of above `api` and `httpMethod`.
    - `httpMethod` string — The http method.
    - `success` integer — The count of successful API requests of above `api` and `httpMethod`.
    - `total` integer — The count of total API requests of above `api` and `httpMethod`.

## Other responses

- `400` — Bad Request

---

[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)