Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Aggregate Queries API

The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database transaction. AQuA enforces the following limits:- The maximum processing time per query is 3 hours. If a query in an AQuA job is executed for longer than 3 hours, this job will be killed automatically. See the best practices for bulk data extraction with AQuA.- AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant: - The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50. AQuA jobs in the following status are counted towards your concurrent AQuA job limits: - Submitted - Executing Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached.For more information about the Aggregate Query API(AQuA), see Aggregate Query.

Zuora Aggregate Queries API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Aggregate Queries. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

4 operations 3 paths 8 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Aggregate Queries 4

The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database…

POST
/v1/batch-query/
Submit an aggregate query job
POST_BatchQueryJob 8 params → 200
GET
/v1/batch-query/jobs/{jobid}
Retrieve an aggregate query job
GET_BatchQueryJob 7 params → 200
DELETE
/v1/batch-query/jobs/{jobid}
Cancel a running aggregate query job
DELETE_BatchQueryJob 7 params → 200
GET
/v1/batch-query/jobs/partner/{partner}/project/{project}
Retrieve the last completed aggregate query job
GET_LastBatchQueryJob 8 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SubmitBatchQueryRequest (14 properties), SubmitBatchQueryResponse (14 properties), GetAggregateQueryJobResponse (11 properties), BatchesQueriesById (11 properties). Each schema is shown below with its type and property counts.

BatchQueries
object
9 properties
BatchesQueriesById
object
11 properties
BatchQuery
object
6 properties
GetAggregateQueryJobResponse
object
11 properties
SubmitBatchQueryResponse
object
14 properties
BatchesQueries
object
9 properties
SubmitBatchQueryRequest
object
14 properties
DeleteBatchQueryJobResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-aggregate-queries-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API
Zuora Catalog API