> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Run a Report

> A Reporting API that starts a new report run and returns the ReportRunId

A Reporting API that starts a new report run and returns the ReportRunId

> **Note**
>
> Contact [Zuora Global Support](https://support.zuora.com/) to enable this feature in your tenant. This feature is currently in development and is subject to change without advance notice.

The **Run a Report** Reporting API starts a new report run and returns the ReportRunId.

Run a Report requires the ReportId value as a request path value. You can obtain the ReportId from the `id` value in the JSON response to a call of **[Search by Report Names](/docs/platform/data/reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/search-by-report-name)** or you can get it definitively from the response to the **Create a Report** call.

## Request

| Environment                       | Request                                                                                                                                                                                                                                                   |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Sandbox (US Data Center)      | **POST [https://zconnectsandbox.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnectsandbox.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                             |
| Production (US Data Center)       | **POST [https://zconnect.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                                           |
| API Sandbox (EU Data Center)      | **POST [https://zconnect.sandbox.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect.sandbox.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                     |
| Production (EU Data Center)       | **POST [https://zconnect.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                                     |
| API Sandbox(US Cloud Data Center) | **POST [https://zconnect.sandbox.na.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect.sandbox.na.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                     |
| Production (US Cloud Data Center) | **POST [https://zconnect.na.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect.na.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**                                     |
| US Central Sandbox                | **POST [https://zconnect-services0001.test.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect-services0001.test.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})**       |
| EU Central Sandbox                | **POST [https://zconnect-services0002.test.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\}](https://zconnect-services0002.test.eu.zuora.com/api/rest/v1/reports/\\\{ReportId\\}/reportrun?viewType=\\\{viewType\\})** |

The Run a Report POST request body must be submitted as JSON content. Set the body content type to "application/json" in the request header: `Content-Type: application/json`

## Request path parameters

<table>
  <tr>
    <td>
      **ReportId**
    </td>

    <td>
      required
    </td>

    <td>
      path
    </td>

    <td>
      The unique identifier for a report.

      You can obtain the ReportId from the `id` value in the JSON response to a call of \*\*[Search by Report Names](/docs/platform/data/reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/search-by-report-name)\*\*or you can get it definitively from the response to the **Create a Report** call.
    </td>
  </tr>

  <tr>
    <td>
      **viewType**
    </td>

    <td>
      required
    </td>

    <td>
      query
    </td>

    <td>
      The value of viewType must be either Detail or Summary depending on the report definition.
    </td>
  </tr>
</table>

## Request body

You can use the request body of **Run a Report** to specify filters to apply when running the report. However, you should only specify filters if you need to override the filters that are defined in the report.

Instead of specifying filters in the request body of **Run a Report**, you can define filters via the report builder in the Zuora UI. For example:

![Reporting Filters For API 2](/_fern-img/ed661b8eb531d17d774e941bf2e05715f26854da281d3d90711adaccfb027f29.webp)

To specify these filters when calling Run a Report, submit the following JSON in the request body:

```json
[
  {
    "logicalOperator": {
      "value": "OR",
      "label": "OPERATOR_OR",
      "name": "or"
    },
    "filterClauses": [
      {
        "field": {
          "name": "Name",
          "id": "Product.Name",
          "label": "Name",
          "type": "text",
          "custom": false,
          "virtual": false,
          "filterable": true,
          "sortable": true,
          "groupable": true,
          "fxEnabled": false,
          "order": 8,
          "dataSourceName": "Product",
          "dataSourceLabel": "Product",
          "dataSourceType": "Product",
          "searchKey": "Product Name"
        },
        "value": "Hockey",
        "operator": {
          "name": "contains",
          "value": "contains"
        }
      },
      {
        "field": {
          "name": "EffectiveStartDate",
          "id": "Product.EffectiveStartDate",
          "label": "Effective Start Date",
          "type": "date",
          "custom": false,
          "virtual": false,
          "filterable": true,
          "sortable": true,
          "groupable": true,
          "fxEnabled": false,
          "order": 6,
          "dataSourceName": "Product",
          "dataSourceLabel": "Product",
          "dataSourceType": "Product",
          "searchKey": "Product Effective Start Date"
        },
        "value": "2018-03-31",
        "operator": {
          "name": "is greater than",
          "value": ">"
        }
      }
    ]
  }
]
```