Overview of BI Views V2
In version 36.008.00, a new version of BI Views API specifications, which is also referred to as integration services, is released. The BI Views APIs are used to download Zuora Revenue data into your data warehouse systems.
Integration service endpoints
Going forward, the Zuora Revenue integration services are available from the provided vanity URL. For example, the Zuora Revenue instance is accessed from the following URL:
Then, the integration service is available from the following URL:
The new version of BI views operations is available under the following path:
For detailed API specifications, see Zuora Revenue API Reference.
New features of BI Views V2
Compared with the previous version, this new version enables accelerated downloads, and downloading of large datasets, and assures data consistency.
An enhancement of BI Views V2 is the accelerated data downloads. This enhancement provides the following features to accelerate data download especially in the large volume scenario:
- Increased row count for download
- Compressed download support
- Use of continuation token
- Selectable fields for download
For more information about this enhancement, see Accelerating downloads.
With the introduction of the continuation token in BI Views V2, after a data query request is made, the status of the query can be retrieved at any time. If a query is pending for a long time, corrective actions can be taken accordingly.
For more information about this feature, see Activity monitoring.
Download data without row counts
It is a common practice to get to know the number of rows that will be returned for a query and then to programmatically scroll for the number of pages to download. In BI Views V2, two approaches are provided to download data.
For large-volume scenarios, the above-mentioned common practice might result in a timeout response when the request to get the row count is made. In this case, it is feasible to start downloading and keep scrolling to a point where there is no more data without knowing the row count.
For more information about this feature, see Download data without row counts.
For optimal use of the system, rate limits are placed on the number of parallel executions that one client can perform against all BI Views and per BI View.
Typically, 5 parallel queries are allowed against all the BI Views. For a given BI view, only one parallel query is allowed.
If these limits are to be breached, a rate limit alert message will be returned when a request to get data is made. To cancel an active task, use the Cancel task operation.
For information about new features provided in BI Views V2 and the suggested pattern to consume the APIs, see New features of BI Views V2.
For sample codes in Python, see Sample codes in Python.
For FAQ information, see Frequently asked questions.