List API failure records

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
Request
query Parameters
page
integer >= 1
Default: 1

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

pageSize
integer <= 40
Default: 20

The number of records returned per page in the response.

path
string

Filters the volume summary by API path name.

You can refer to the API listed in the API System Health Dashboard for the path name.

Example: path=/v1/accounts/{account-key}
httpMethod
string

Filters the volume summary by http method.

Example: httpMethod=POST
responseCode
string

Filters the volume summary by response code.

Example: responseCode=INVALID_TYPE
requestId
string

Filters the volume summary by request ID.

trackId
string

Filters the volume summary by track ID.

sort
string

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form: operator field_name.

If you do not specify any sortable field, the response data is sorted by the timerange field in descending order.

operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.
  • The + operator indicates a descending order.

field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below:

  • timerange
  • latency
  • http_method
  • http_status
  • api
Example: sort=sort=+latency
startTime
required
string <date-time>

Start time of the volume summary.

Format: yyyy-MM-dd'T'HH:mmZ.

Example: startTime=2022-09-22T09:07+0800
endTime
required
string <date-time>

End time of the volume summary.

Format: yyyy-MM-dd'T'HH:mmZ

Example: endTime=2022-09-29T09:07+0800
header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Responses
200

OK

400

Bad Request

get/system-health/api-requests/failures
Request samples 
curl -i -X GET 'https://rest.zuora.com/system-health/api-requests/failures?startTime=2024-08-01T09%3A07%2B0800&endTime=2024-08-05T09%3A07%2B0800&page=1&limit=10&sort=-timestamp' \
-H 'Authorization: Bearer 2c129bd58623470a8a8b713d26477c97'
Response samples
application/json
{
  • "data": [
    ],
  • "nextPage": "https://rest.zuora.com/system-health/api-requests/failures?startTime=2024-08-01T09:07+0800&endTime=2024-08-05T09:07+0800&limit=10&page=2"
}