---
title: "Submit a data query"
method: POST
path: "/query/jobs"
tags: ["Data Queries"]
---

# Submit a data query

`POST /query/jobs`

Submits a [data query](https://docs.zuora.com?resourceId=platform-data-query-overview) to be executed by Zuora, creating a new query job. Use the [Retrieve a data query job](https://developer.zuora.com/v1-api-reference/api/operation/GET_DataQueryJob/) endpoint to monitor the job status and access the results once complete.

**Note:** The request must include the `Content-Type: application/json` header. If this header is missing, the request will fail with the following error:   `{"code":415,"message":"HTTP 415 Unsupported Media Type"}`

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string
- `Content-Type` 'application/json', required

## Request body

- SubmitDataQueryRequest
  - `columnSeparator` string — The column separator. Only applicable if the `outputFormat` is `DSV`.
  - `compression` 'NONE' | 'GZIP' | 'ZIP', required — Specifies whether Zuora compresses the query results.
  - `encryptionKey` string, byte — Base-64 encoded public key of an RSA key-pair. Note that Data Query only supports 1024-bit RSA keys. If you set this field, Zuora encrypts the query results using the provided public key. You must use the corresponding private key to decrypt the query results.
  - `output` object, required — Additional information about the query results.
    - `target` 'S3', required — Set this field to `S3`.
  - `outputFormat` 'JSON' | 'CSV' | 'TSV' | 'DSV', required — Specifies the format of the query results. * `JSON` - Each row in the query results will be a JSON object. The format of the query result file is [JSON Lines](http://jsonlines.org/). * `CSV` - Each row in the query results will be a comma-separated list of values. * `TSV` - Each row in the query results will be a tab-separated list of values. * `DSV` - Pass any character as your custom delimiter into the `columnSeparator` field.
  - `query` string, required — The query to perform. See [SQL Queries in Data Query](https://docs.zuora.com?resourceId=platform-sql-queries-in-data-query) for more information.
  - `readDeleted` boolean — Indicates whether the query will retrieve only the deleted record. If `readDeleted` is set to `false` or it is not included in the request body, the query will retrieve only the non-deleted records. If it is set to `true`, only the deleted records will be retrieved. If you select the `deleted` column in the `query` field, both non-deleted and deleted records will be retrieved regardless of the value in the `readDeleted` field. Note that Data Query is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through Data Query.
  - `sourceData` 'LIVE' | 'WAREHOUSE' — Specify the source that data queries run 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. This option is available only if you have the Zuora Warehouse feature enabled in your tenant. For more information, see <a href="https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview" target="_blank">Zuora Warehouse</a>. <br>If this option is selected, you can specify warehouse size in `warehouseSize`. If this field is not specified, the default value `LIVE` will be used.
  - `useIndexJoin` boolean — Indicates whether to use Index Join. Index join is useful when you have a specific reference value in your WHERE clause to index another large table by. See [Use Index Join](https://docs.zuora.com?resourceId=platform-data-query-practices) for more information.
  - `warehouseSize` 'xsmall' | 'NULL' — Specify the size of Zuora Warehouse. This field is available only if the `sourceData` is `WAREHOUSE`. If this field is not specified or set to `NULL`, the default value `xsmall` will be used.

## Response `200`

OK

- SubmitDataQueryResponse
  - `data` DataQueryJob — A data query job.
    - `createdBy` string, uuid — The query job creator's Id.
    - `id` string, uuid — Internal identifier of the query job.
    - `query` string — The query that was submitted.
    - `remainingRetries` integer — The number of times that Zuora will retry the query if Zuora is unable to perform the query.
    - `sourceData` string — Indicates the source that data queries run 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 <a href="https://docs.zuora.com?resourceId=platform-zuora-warehouse-overview" target="_blank">Zuora Warehouse</a>.
    - `updatedOn` string, date-time — Date and time when the query job was last updated, in ISO 8601 format.
    - `useIndexJoin` boolean — Indicates whether to use Index Join. See <a href="https://docs.zuora.com?resourceId=platform-data-query-practices" target="_blank">Index Join</a> for more information.
    - `dataFile` string, URL — The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`.
    - `outputRows` integer — The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`.
    - `processingTime` integer — Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`.
    - `queryStatus` 'submitted' | 'accepted' | 'in_progress' | 'completed' | 'failed' | 'cancelled' — Status of the query job. * `submitted` - query submitted to query service for processing * `accepted` - query accepted by the query service * `in_progress` - query executed by the query service * `completed` - query execution completed by the query service * `failed` - query unable to be processed by the query service * `cancelled` - query cancelled by the user If the value of this field is `completed`, the `dataFile` field contains the location of the query results. If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/DELETE_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`.

## Other responses

- `400` — Bad Request
- `415` — Unsupported Media Type. This error is returned when the request is missing the required `Content-Type: application/json` header.

---

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