Skip to main content

Zuora BI Views

BI Views are pre-defined business-intelligence datasets in Zuora Revenue that expose your revenue recognition data for reporting and downstream analysis. The Nexla Zuora BI Views ingestor automatically downloads the data from a specified BI view as CSV files and extracts the results into Nexla datasets on a configurable schedule. It authenticates against the Zuora Revenue API using your Zuora Revenue credential, so no separate connection setup is required beyond providing that credential and the view details.

Zuora BI Views icon

Power end-to-end data operations for your Zuora BI Views API with Nexla. Our bi-directional Zuora BI Views connector is purpose-built for Zuora BI Views, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zuora BI Views or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zuora BI Views workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

The Zuora BI Views ingestor uses your Zuora Revenue API credential to authenticate. Before configuring it in Nexla, you need your Zuora Revenue API Base URL, Authorization Key (Base64-encoded username:password), API User Role, and Client Name from your Zuora Revenue account. Zuora Revenue uses token-based authentication: the connector supplies your Base64 basic-authorization value along with your role and client name to generate a short-lived token, then uses that token to download the requested BI view.

To prepare your Zuora Revenue credentials, follow these steps:

  1. Confirm that the Zuora Revenue API service is enabled for your tenant. The API service must be enabled before any API request will succeed; contact Zuora Revenue Support to enable it if needed.

  2. Sign in to your Zuora Revenue account using your administrator credentials.

  3. Identify your Zuora Revenue API Base URL. The Base URL depends on your Zuora Revenue environment and region. See the Zuora Revenue API documentation for details about the environment endpoints.

  4. Construct your Authorization Key by Base64-encoding your Zuora Revenue username and password in the format username:password. This encoded value is used for basic authorization when the connector requests an authentication token.

  5. Determine your API User Role and Client Name. These are the role and client name assigned to your API user in Zuora Revenue, and they are sent as the role and clientname request headers when authenticating.

  6. Store all values securely, as you will need them to configure your Nexla credential. The Authorization Key is sensitive information and should be kept confidential.

For detailed information about Zuora Revenue API authentication and the BI Views operation, see the Zuora Revenue BI Views API documentation.

Authenticate​

Create a credential in Nexla​

  1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Zuora Revenue API Base URL in the corresponding field. The Base URL depends on your Zuora Revenue environment and region and determines which Zuora Revenue instance is accessed.

  4. Enter your Authorization Key in the corresponding field. This should be your Zuora basic authorization token, set to Base64Encode(username:password). The Authorization Key is used to obtain an authentication token for subsequent API requests and must be kept confidential.

  5. Enter your API User Role and Client Name in their respective fields. These are sent in the role and clientname headers when the connector authenticates with the Zuora Revenue API.

    Your Zuora Revenue credentials can be found in your Zuora Revenue account settings. If your credentials are compromised, change your password in Zuora Revenue and regenerate the Authorization Key. For detailed information, see the Zuora Revenue API documentation.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation and can be selected for use with a new data source.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Zuora BI Views connector tile, then select the credential that will be used to connect to your Zuora Revenue account, and click Next; or, create a new Zuora Revenue credential for use in this flow.

Endpoint templates​

The Zuora BI Views ingestor downloads data from a Zuora Revenue BI view. Configure the view and download parameters using the template below.

Get BI Views

Downloads data from a BI view in CSV files. Use this template to ingest a Zuora Revenue BI view on a schedule and extract the downloaded CSV data into Nexla datasets.

  • Enter the name of the BI view to download in the BI View Name field. This must match the name of an existing BI view in your Zuora Revenue account.
  • Enter the query string in the URL Params field to scope the download — for example, clientId=1&fromDate={now-1}&toDate={now}&outputType=csv. Do not include the pagenum parameter, as it is added automatically by the connector. The {now} and {now-1} Nexla macros resolve to the current run time and the prior interval, allowing the date range to advance automatically on each fetch.
  • Set how often the data should be fetched using the How often should this data be fetched? schedule control.

For detailed information about the BI Views operation, supported query parameters, and response format, see the Zuora Revenue BI Views API documentation.

Once the endpoint has been configured, click the Create button in the upper right corner of the screen to save and create the new Zuora BI Views data source. Nexla will download the BI view data on the configured schedule and organize the extracted CSV data into one or more Nexsets.