Import Zuora Data into Microsoft Power Query

The API Server, when paired with the ADO.NET Provider for Zuora (or any of 200+ other ADO.NET Providers), enables you to use Web services to connect to and query Zuora data. This article details how to import an OData feed of Zuora data into Microsoft Power Query.

Set Up the API Server

Follow the steps below to begin producing secure Zuora OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Zuora

After you deploy the API Server and the ADO.NET Provider for Zuora, provide authentication values and other connection properties needed to connect to Zuora by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

Configuring Tenant property

In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

• USProduction: Requests sent to https://rest.zuora.com.
• USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
• USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
• EUProduction: Requests sent to https://rest.eu.zuora.com"
• EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

Selecting a Zuora Service

Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

DataQuery

The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

• The maximum number of input records per table after filters have been applied: 1,000,000
• The maximum number of output records: 100,000
• The maximum number of simultaneous queries submitted for execution per tenant: 5
• The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
• The maximum processing time for each query in hours: 1
• The maximum size of memory allocated to each query in GB: 2
• The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

AQuADataExport

AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

• If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
• The killed AQuA job can be retried three times before returned as failed.

You can then choose the Zuora entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Connect to Zuora Data from Power Query

Follow the steps below to import tables that can be refreshed on demand:

1. Configure the API Server to use a version of the OData protocol that is recognized by Power Query. In the API Server administration console, click Settings -> Server and change the value of the Default Version property to 3.0.

2. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From OData Feed, and enter the OData URL:

   https://your-server:8032/api.rsc

3. In the next step of the wizard, define authentication credentials and set privacy levels. Select Basic authentication and enter the credentials for a user authorized to make requests. Specify the Username field and enter the user's authtoken in the Password field.

   To change the authentication scheme that Power Query will use, click Power Query -> Data Source Settings. Select the OData feed from the list and then click Edit Credential. Select the privacy level from the menu on the Data Source Settings page.

   

4. You can now access Zuora data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Edit to open the Query Editor. This will display the table data.