Overview of the Zuora Reporting API

Endpoints

The endpoints of the Reporting API are the same as the endpoints of Zuora REST API. Please refer to Zuora API reference for more information.

The following API operations are available:

• Search by Report Name
• Run a Report
• Get Report Run
• Get Last Completed Report Run
• Get Report Data
• Export Report Run
• Cancel a Report Run

Authentication

You can use the following methods to authenticate to the Reporting API:

• Set the apiAccessKeyId and apiSecretAccessKey headers to the username and password of a Zuora user. For example:

  curl https://zconnectsandbox.zuora.com/api/rest/v1/reports/search?query=customer%20report \
    -H "apiAccessKeyId: {username}" \
    -H "apiSecretAccessKey: {password}" \

  Do not include the braces when setting the apiAccessKeyId and apiSecretAccessKey headers. For example, if your Zuora username is user@example.com and your Zuora password is LfBeS7KK, the sample call above would be:

  curl https://zconnectsandbox.zuora.com/api/rest/v1/reports/search?query=customer%20report \
    -H "apiAccessKeyId: user@example.com" \
    -H "apiSecretAccessKey: LfBeS7KK" \

  Zuora recommends that you authenticate to the Reporting API using the credentials of a dedicated API user, rather than using your own Zuora credentials. See Create an API User for more information.

  To ensure that the user credentials can be used to access the Reporting API, the user must have logged in to the Zuora UI and navigated to Reporting at least once. If you plan to authenticate to the Reporting API using the credentials of a dedicated API user, the user must navigate to Reporting in the Zuora UI before becoming a dedicated API user.

  When you authenticate to the Reporting API using the credentials of a dedicated API user, you can only access reports that are visible to the API user. To ensure that your reports are visible to the API user, save your reports in a shared folder. See Folders and Sharing for more information.

• Use the Zuora session token from your active browser session. Log in to Zuora and your browser will store a cookie that can be used to authenticate and send API requests. To use your browser session key to authenticate to the Reporting API, you will need an API client that is integrated with your browser.

The Reporting API does not support OAuth or Basic Authentication.

curl https://zconnectsandbox.zuora.com/api/rest/v1/reports/search?query=customer%20report \
  -H "entityName: EuropeanBU" \
  -H "apiAccessKeyId: {username}" \
  -H "apiSecretAccessKey: {password}" \

Examples

You can use the Reporting API to export the results of a report that you created in the Zuora UI. At a high level, the process is:

1. Use the report builder to create a report in the Zuora UI. See Create a Summary Report for more information.
2. Use the Reporting API to obtain the internal identifier of the report.
3. Use the Reporting API to run the report.
4. Use the Reporting API to download the report results as a CSV file.

{
  "success": true,
  "response": {
    "reports": [
      {
        "createdBy": "2c92c0f956bc8fcb0156f8eee04b4d54",
        "updatedBy": "2c92c0f956bc8fcb0156f8eee04b4d54",
        "createdOn": "2018-04-13T01:52:10+0000",
        "updatedOn": "2018-04-13T01:52:10+0000",
        "id": "ff8080816293d35b0162bcb3e7780a75",
        "deleted": false,
        "name": "Customer report",
        "number": "REP0000007",
        "type": "Common",
        "datasource": "Account",
        "dsName": "Account",
        "namespace": "BASIC",
        "definition": "...",
        "userId": "2c92c0f956bc8fcb0156f8eee04b4d54",
        "creator": "user@example.com",
        "updater": "user@example.com",
        "favorite": false,
        "shared": true,
        "zuora": false,
        "hidden": false
      }
    ],
    "count": 1
  }
}

{
  "success": true,
  "response": {
    "reportRunId": "ff808081629755b80162bcc5bd624d2d"
  }
}

{
  "success": true,
  "response": {
    "reportType": "Summary",
    "id": "ff808081629755b80162bcc5bd624d2d",
    "reportId": "ff8080816293d35b0162bcb3e7780a75",
    "startedOn": "2018-04-13T02:11:38.464+0000",
    "status": "COMPLETED",
    "reportDefinition": "...",
    "updatedOn": "2018-04-13T02:11:40.008+0000"
  }
}

Account: Currency    Sum of Account: Account Balance
EUR                  4,800
USD                  22,600.95