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

# List API failure records

`GET /system-health/api-requests/failures`

Returns failure records of API usage that are generated by your Zuora tenant within a specified time range.


You can filter the failure records by one or multiple of the following fields:
  - API path name
  - HTTP method
  - Response code 
  - Request ID
  - Track ID

## Query parameters

- `page` integer
- `pageSize` integer
- `path` string
- `httpMethod` string
- `responseCode` string
- `requestId` string
- `trackId` string
- `sort` 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

- GetApiFailureRecordResponse
  - `data` ApiFailureRecord[] — List of Failed API records
    - `tracing_identifier` string, nullable — A unique identifier for tracing the request.
    - `latency` integer — The time taken to process the request in milliseconds.
    - `ip` string — The IP address from which the request originated.
    - `response_body` string — The body of the response returned by the API.
    - `request_body` string — The body of the request sent to the API.
    - `user_id` string — The ID of the user making the request.
    - `track_id` string, nullable — A tracking identifier for the request.
    - `request_path` string — The complete path of the API request triggered by the user.
    - `http_status` string — The HTTP status code returned by the API.
    - `zuora_response_code` string — The response code returned by Zuora.
    - `api` string — The path of the API request.
    - `request_id` string — A unique identifier for the API request.
    - `user_agent` string — The user agent string of the client making the request.
    - `timestamp` string, date-time — The timestamp when the request was made.
    - `status` 'Error' — The status of the request.
    - `http_method` string — Type of request method performed for the API endpoint.
  - `nextPage` string, url — URL to the next page of results for pagination.

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