Download BI view

Downloads data from a BI view in a CSV or gzip file.

If the data volume is large, it is recommended to use this operation to download Page 1 first. A continuation token will be returned in the response header. After that, provide the continuation token in this operation to download the subsequent pages.

Request
path Parameters
view_name
required
string

Name of the BI view.

query Parameters
clientId
required
integer
Default: 1

The ID of the Zuora Revenue application user.

fromDate
required
string
Default: "2016-07-26T00:00:00"

The date from which the data query begins.

toDate
required
string
Default: "2018-07-26T00:00:00"

The date on which the data query ends.

pagenum
integer
Default: 1

The number of page to be downloaded.

pageSize
integer

The number of rows on each page to be downloaded.

  • For CSV format, the valid range is 1 - 10,000 with default 1,000.
  • For gzip format, the valid range is 1 - 20,000 with default 1,000.

Note: Any value that is greater than 20,000 is invalid.

outputType
string
Default: "gzip"

The output format of the download.

Enum: "csv" "gzip"
header Parameters
token
required
string

The valid authentication token that is generated by the Authentication operation.

continuation-token
string

The continuation token that was returned in the initial query for Page 1.

Note: The continuation token is returned after Page 1 of the BI view is downloaded. To download the subsequent pages, you must specify the continuation token in this operation for Page 2 onwards.

Request Body schema: application/json; charset=utf-8
required
Array
string
Responses
200

The queried BI view data is returned in the desired format.

204

No record is found for the specified BI view.

400

Error occurs. For example, the user ID is invalid, or the requested page is not cached yet.

401

The provided authentication token has expired. Send the Authentication request again to get a new token.

404

The requested page does not exist. The number of total pages and the number of total rows are returned.

get/api/integration/v2/biviews/{view_name}
Request samples
application/json; charset=utf-8
[
  • "string"
]