Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see APIs dashboard.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zuora-api-health-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: '2023-12-15'
title: Reference API Health API
description: '# Introduction
Welcome to the REST API reference for the Zuora Billing, Payments, and Central Platform!'
contact:
email: docs@zuora.com
servers:
- url: https://rest.zuora.com/
tags:
- name: API Health
description: Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see APIs dashboard.
paths:
/system-health/api-requests/volume-summary:
get:
operationId: GET_SystemHealthApiVolumeSummary
summary: List API volume summary records
description: 'Returns volume summary of 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.'
tags:
- API Health
parameters:
- $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
- $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
- $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
- name: path
in: query
required: false
description: 'Filters the volume summary by API path name.
You can refer to the api listed in the [API System Health Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard) for the path name. Example: `/v1/accounts/{account-key}`.
'
schema:
type: string
- name: httpMethod
in: query
required: false
description: 'Filters the volume summary by http method. Example: `POST`.
'
schema:
type: string
- name: startTime
in: query
required: true
description: 'Start time of the volume summary.
Format: `yyyy-MM-dd''T''HH:mmZ` Example: `2022-09-22T09:07+0800`.
'
schema:
type: string
format: date-time
- name: endTime
in: query
required: true
description: 'End time of the volume summary.
Format: `yyyy-MM-dd''T''HH:mmZ` Example: `2022-09-29T09:07+0800`.
'
schema:
type: string
format: date-time
responses:
'200':
description: OK
headers:
Content-Encoding:
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
schema:
type: string
maxLength: 36
minLength: 36
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
schema:
type: string
maxLength: 64
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiVolumeSummaryResponse'
example:
data:
- path: /notifications/notification-definitions
httpMethod: DELETE
success: 10
error: 0
total: 10
- path: /query/jobs/{job-id}
httpMethod: GET
success: 10
error: 20
total: 30
- '...'
'400':
description: Bad Request
headers:
Content-Encoding:
description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n - `text/plain`\n"
schema:
type: string
RateLimit-Limit:
description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: string
RateLimit-Remaining:
description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: number
RateLimit-Reset:
description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.
'
schema:
type: number
Zuora-Request-Id:
description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.
'
schema:
type: string
maxLength: 36
minLength: 36
Zuora-Track-Id:
description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
'
schema:
type: string
maxLength: 64
content:
application/json:
schema:
$ref: '#/components/schemas/SystemHealthErrorResponse'
example:
timestamp: '2022-09-29T05:54:46.007+00:00'
status: 400
error: Bad Request
message: Timezone is different between 'startTime' and 'endTime'.
path: /system-health/api-requests/volume-summary
x-code-samples:
- lang: curl
label: Curl
source: "curl -i -X GET \\\n 'https://rest.zuora.com/system-health/api-requests/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \\ \n -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'\n"
components:
schemas:
ApiVolumeSummaryRecord:
allOf:
- properties:
api:
description: 'The API path name.
'
type: string
error:
description: 'The count of failed API requests of above `api` and `httpMethod`.
'
type: integer
httpMethod:
description: 'The http method.
'
type: string
success:
description: 'The count of successful API requests of above `api` and `httpMethod`.
'
type: integer
total:
description: The count of total API requests of above `api` and `httpMethod`.
type: integer
type: object
description: 'A volume summary record.
'
title: volumeSummaryRecord
SystemHealthErrorResponse:
properties:
error:
description: 'Error status text.
'
type: string
message:
description: 'The associated reason.
'
type: string
path:
description: 'The system health api path having error.
'
type: string
status:
description: 'Error status code.
'
type: integer
timestamp:
description: 'The time when error happens.
'
format: date-time
type: string
type: object
GetApiVolumeSummaryResponse:
properties:
data:
description: "List of API volume summary records. The records are grouped and ordered by API path name and http method. \n"
items:
$ref: '#/components/schemas/ApiVolumeSummaryRecord'
type: array
type: object
parameters:
GLOBAL_HEADER_Authorization_OAuth:
name: Authorization
in: header
required: true
description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](/api-references/api/operation/createToken).
'
schema:
type: string
GLOBAL_HEADER_Zuora_Track_Id:
name: Zuora-Track-Id
in: header
required: false
description: '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 (`''`).
'
schema:
type: string
maxLength: 64
GLOBAL_HEADER_Content_Encoding:
name: Content-Encoding
in: header
required: false
description: '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.
'
schema:
type: string
GLOBAL_HEADER_Accept_Encoding:
name: Accept-Encoding
in: header
required: false
description: "Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf 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.\n"
schema:
type: string
GLOBAL_HEADER_Zuora_Entity_Ids_Single:
name: Zuora-Entity-Ids
in: header
required: false
description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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 do not need to set this header.
'
schema:
type: string
GLOBAL_HEADER_Zuora_Org_Ids:
name: Zuora-Org-Ids
in: header
required: false
description: "Comma separated IDs. If you have <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org\" target=\"_blank\">Zuora Multi-Org</a> enabled, \nyou 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.\n\nThe 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.\n\nIf the header is not set, the operation is performed in scope of the user's accessible orgs.\n"
schema:
type: string
x-tagGroups:
- name: Authentication
tags:
- OAuth
- name: Products
tags:
- Products
- Catalog
- Catalog Groups
- Offers
- Price Book Items
- Product Rate Plans
- Product Rate Plan Definitions
- Product Rate Plan Charges
- Product Charge Definitions
- Product Rate Plan Charge Tiers
- Zuora Revenue Integration
- name: Customer Accounts
tags:
- Accounts
- Contacts
- Contact Snapshots
- name: Orders and Subscriptions
tags:
- Sign Up
- Orders
- Order Actions
- Order Line Items
- Fulfillments
- Ramps
- Subscriptions
- Rate Plans
- name: Advanced Consumption Billing
tags:
- Prepaid with Drawdown
- name: Usage
tags:
- Usage
- name: Billing Documents
tags:
- Delivery Adjustments
- Billing Documents
- Invoices
- Credit Memos
- Debit Memos
- E-Invoicing
- Invoice Schedules
- Taxation Items
- Sequence Sets
- Operations
- name: Bill Runs
tags:
- Bill Run
- Billing Preview Run
- name: Payment Methods
tags:
- Payment Methods
- Custom Payment Method Types
- Payment Method Updater
- Payment Method Snapshots
- Payment Method Transaction Logs
- Hosted Pages
- RSA Signatures
- name: Payments
tags:
- Payment Authorization
- Payment Gateways
- Payment Gateway Reconciliation
- Payments
- Payment Transaction Logs
- Payment Runs
- Payment Schedules
- Refunds
- name: Finance
tags:
- Accounting Codes
- Accounting Periods
- Summary Journal Entries
- Journal Runs
- Mass Updater
- name: Events and Notifications
tags:
- Notifications
- Custom Event Triggers
- Custom Scheduled Events
- name: Custom Objects
tags:
- Custom Object Definitions
- Custom Object Records
- Custom Object Jobs
- name: System Health
tags:
- API Health
- Bill Run Health
- Electronic Payments Health
- name: Workflow
tags:
- Workflows
- name: Data Query
tags:
- Data Queries
- name: AQuA
tags:
- Aggregate Queries
- name: Deployment Manager
tags:
- Configuration Templates
- name: Multiple Organizations
tags:
- Data Labeling
- name: Order to Revenue
tags:
- Regenerate
- name: General-Purpose Operations
tags:
- Actions
- Settings
- Files
- Imports
- Custom Exchange Rates
- Attachments
- Describe