--- title: "Retrieve an aggregate query job" method: GET path: "/v1/batch-query/jobs/{jobid}" tags: ["Aggregate Queries"] --- # Retrieve an aggregate query job `GET /v1/batch-query/jobs/{jobid}` Retrieves an aggregate query using the Job ID. Note that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder. ## Path parameters - `jobid` string, required ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Track-Id` string - `Zuora-Version` string ## Response `200` OK - GetAggregateQueryJobResponse - `batches` BatchesQueriesById[] — A JSON array object that contains a list of batch objects. - `apiVersion` string — The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API. **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields. - `batchId` string — A 32-character ID of the query batch. - `batchType` 'zoql' | 'zoqlexport' — The kind of batch job being submitted. - `fileId` string — The ID of the query results file. Use Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. - `full` boolean — This field indicates a full or incremental load. `True` = Full and `False` = Incremental. - `message` string — The error message. - `name` string — Name of the query supplied in the request. - `query` string — The requested query string. - `recordCount` string — The number of records included in the query output file. - `segments` unknown[] — Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if File Segmentation is enabled. Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. - unknown - `status` 'submitted' | 'pending' | 'executing' | 'completed' | 'aborted' | 'deleted_notallowed' — The status of the query task: - submitted: The query was submitted to the query executor for processing. - pending: The query was waiting for being processed. - executing: The query is being processed. - completed: The query was successfully executed. - aborted: The query execution failed. - deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records. - `encrypted` 'pgp' | 'none' — If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents. - `format` 'csv' | 'zip' | 'gzip' — The format of the query. The default value is `csv`. - `id` string — The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null. - `name` string — The name of the job. 32 character limit. - `partner` string — The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with "project" field to uniquely identify a data integration target. For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices. **Note**: Submit a request at Zuora Global Support to obtain a partner ID. - `project` string — The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days. This field must be used together with partner field to uniquely identify a data integration target. This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. - `sourceData` string — Indicates the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see Zuora Warehouse. - `startTime` string — The start time of the query. - `status` 'submitted' | 'executing' | 'completed' | 'error' | 'aborted' | 'cancelled' — The status of the AQuA job: - submitted: The AQuA job was submitted to the query executor for processing. - executing: The AQuA job is being processed. - completed: The AQuA job was successfully executed. - error: The AQuA job was not processed because of validation errors. - aborted: The AQuA job execution failed because one or more queries of this job failed. - cancelled: The AQuA job was cancelled. - `version` number, float — The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See Stateless and stateful modes for more information. --- [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)