Reporting

The Zuora Reporting API enables you to access reports that you have created in the Zuora UI, manage report runs, and export the results of report runs.

The endpoints of the Reporting API are the same as the endpoints of Zuora REST API. The following table provides some endpoints as reference:

Environment	API Endpoint
API Sandbox (US Cloud Data Center 1)	https://rest.sandbox.na.zuora.com
Production (US Cloud Data Center 1)	https://rest.na.zuora.com
API Sandbox (US Cloud Data Center 2)	https://rest.apisandbox.zuora.com
Production (US Cloud Data Center 2)	https://rest.zuora.com
API Sandbox (EU Data Center)	https://rest.sandbox.eu.zuora.com
Production (EU Data Center)	https://rest.eu.zuora.com
US Central Sandbox	https://rest.test.zuora.com
EU Central Sandbox	https://rest.test.eu.zuora.com
APAC Developer & Central Sandbox	https://rest.test.ap.zuora.com
APAC Production	https://rest.ap.zuora.com

Historically, the endpoints of the Reporting API were different from the endpoints of the Zuora REST API.

Note that you are still able to use the following endpoints, but it is unrecommended and you can only use username and password to authenticate to the Reporting API. We recommend you to use OAuth to authenticate to the Reporting API. OAuth only works with new endpoints. The endpoints of the Reporting API were:

Environment	API Endpoint
API Sandbox (US Cloud Data Center 1)	https://zconnect.sandbox.na.zuora.com/api/rest/v1
Production (US Cloud Data Center 1)	https://zconnect.na.zuora.com/api/rest/v1
API Sandbox (US Cloud Data Center 2)	https://zconnectsandbox.zuora.com/api/rest/v1
Production (US Cloud Data Center 2)	https://zconnect.zuora.com/api/rest/v1
API Sandbox (EU Data Center)	https://zconnect.sandbox.eu.zuora.com/api/rest/v1
Production (EU Data Center)	https://zconnect.eu.zuora.com/api/rest/v1
US Central Sandbox	https://zconnect-services0001.test.zuora.com/api/rest/v1
EU Central Sandbox	https://zconnect-services0002.test.eu.zuora.com/api/rest/v1
APAC Developer & Central Sandbox	https://zconnect-services0003.test.ap.zuora.com
APAC Production	http://zconnect-prod05.ap.zuora.com

Operations

Retrieve a report run

Request

Retrieves details of the specific report run.

Path

reportRunIdstringrequired

The ID of the report run. You can get the ID from the JSON response to Run a Report.

Accept-Encodingstring

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-Encodingstring

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.

Authorizationstringrequired

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Idsstring

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-Track-Idstring, <= 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 (').

cURL

curl -i -X GET \
  'https://rest.zuora.com/reporting/api/rest/v1/reportruns/{reportRunId}' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

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.

Bodyapplication/json

idstring

The ID of the report run. This value matches the value of the reportRunId request parameter.

statusstring

Status of the report run.

started - The report run has started. The query has not been submitted.
querydata - The query has been submitted. The results have not been received.
processingdata - The results have been received. The results are being processed.
completed - The report run has finished successfully. The results are available for download using Get Report Data or Export Report Run.
cancelled - The report run was canceled by the user.
invalid - The report definition or data is invalid.
error - The report run has finished with an error.

Enum:"started""querydata""processingdata""completed""cancelled""invalid""error"

startedOnstring, (date-time)

The timestamp of when the report run was started.

updatedOnstring, (date-time)

The timestamp of when the status of the report run was last updated.

reportIDstring

The ID of the report that was run.

reportTypestring

The type of the report that was run.

Enum:"detail""summary"

reportDefinitionstring

The definition of the report that was run.

Response

{
  "success": true,
  "response": {
    "reportType": "Detail",
    "id": "ff808081529f4e3401529fd61f080074",
    "reportId": "ff808081529f4e3401529fd373730070",
    "startedOn": 1453166692000,
    "status": "COMPLETED",
    "reportDefinition": "...",
    "updatedOn": 1453166695000
  }
}