Submit a data query

Submits a data query to be performed by Zuora and creates a query job. You can use Retrieve a data query job to track the status of the query job and obtain the URL of the query results.

Request
header Parameters
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.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

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 do not need to 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 (').

Request Body schema: application/json
required
query
required
string

The query to perform. See SQL Queries in Data Query for more information.

outputFormat
required
string

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.
  • 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.
Enum: "JSON" "CSV" "TSV" "DSV"
compression
required
string

Specifies whether Zuora compresses the query results.

Enum: "NONE" "GZIP" "ZIP"
required
object

Additional information about the query results.

columnSeparator
string

The column separator. Only applicable if the outputFormat is DSV.

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.

readDeleted
boolean
Default: false

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
string

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 Zuora Warehouse.
    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.

Enum: "LIVE" "WAREHOUSE"
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 for more information.

warehouseSize
string

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.

Enum: "xsmall" "NULL"
Responses
200

OK

400

Bad Request

post/query/jobs
Request samples
application/json
{
  • "compression": "NONE",
  • "output": {
    },
  • "outputFormat": "JSON",
  • "query": "SELECT accountnumber, balance FROM Account WHERE Account.balance > 100",
  • "sourceData": "LIVE"
}
Response samples
application/json
{
  • "data": {
    }
}