Get BI Views

Retrieves the data from a BI view during the specified time period in a CSV file. Use the fromDate and toDate parameters to specify the time period for which data is to be queried. You can also use the count parameter to get the row count for the queried bi view data.

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: "2016-07-26T00:00:00"

The date on which the data query ends.

pagenum
required
integer
Default: 1

The number of page to download.

pagesize
integer

The number of records to be downloaded per request. The default is 1000 and the maximum is 10000.

count
boolean
Default: null

Set to true to get the row count of the BI view for the specified time period.

Note: Setting this parameter to true might cause timeout errors for large volume scenarios.

header Parameters
token
required
string

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

Responses
200

BI view data is returned in CSV format.

204

No rows are found for the specified time period.

400

Error is returned. For example, the user ID is invalid, or the BI view does not exist.

401

The authentication token has expired. To solve this problem, re-generate a token by using the Authentication operation.

get/api/integration/v1/biviews/{view_name}
Request samples 
curl -X GET --header "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlpJTkdBUEkiLCJpc3MiOiJSRVZQUk8gMy4wIFdlYnNlcnZpY2VzIiwicm9sZSI6IlJldnBybyBBUEkgUm9sZSIsImV4cCI6MTUwNDc0ODE4MywiaWF0IjoxNTA0NzQ2MzgzLCJuYmYiOjE1MDQ3NDYzODMsImNsaWVudG5hbWUiOiJEZWZhdWx0In0.k1usDPkgldj-OG9-ga-jn5B2Axx-HG4D0chytx5JPIg"  "https://yourHost/api/integration/v1/biviews/BI3_RC_POB?clientId=1&fromDate=2016-07-26T00%3A00%3A00&toDate=2016-07-26T00%3A00%3A00&pagenum=1"