Run a report

Starts a new report run and returns the ID of the report run.

Request
path Parameters
ReportId
required
string

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 or you can get it definitively from the response to the Create a Report call.

query Parameters
viewType
required
string

The value of viewType must be either Detail or Summary depending on the report definition.

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

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.

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-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
logicalOperator
string

Operator that defines the relationship between files.

Enum: "AND" "OR"
filterClauses
string

Defines the filter under a specific logicalOperator.

object

The type of the field that you want to use as the filter.

operator
string

Supports the following opertors:

=, !=, <, >, <=, >=, in, not in,is null, is not null, contains, does not contain, starts with, does not start with, ends with, does not end with, like, is between, is not between, is during, is not during

Responses
200

OK

post/reporting/api/rest/v1/reports/{ReportId}/reportrun
Request samples
application/json
{
  • "logicalOperator": {
    },
  • "filterClauses": {
    }
}
Response samples
application/json
{
  • "success": true,
  • "response": {
    }
}