OData Connector for Power BI
In this article you will learn how to integrate Using OData Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to OData in other apps
|
Video Tutorial - Integrate OData data in Power BI
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
OData integration in Power BI - How to configure connection for
OData - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
OData Connection in Power BI
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from OData using Power BI we first need to create a DSN (Data Source) which will access data from OData. We will later be able to read data using Power BI. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API Driver
You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "OData" from the list of Popular Connectors. If "OData" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
OdataDSNOData
-
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNo Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcOptional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion 
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataWindows Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcThis Authentication Type has no parameters to fill-in.
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataBasic Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataNTLM Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters UserName (i.e. Domain\UserName) Fill-in the parameter... Password Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataToken Authentication [Http]https://services.odata.org/V3/Northwind/Northwind.svcRequired Parameters Token Fill-in the parameter... Optional Parameters AuthScheme Bearer AuthHeader Authorization RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion
Fill in all required parameters and set optional parameters if needed:
OdataDSNODataOAuth Connection for OData API [OAuth]https://services.odata.org/V3/Northwind/Northwind.svcOptional Parameters GrantType Default OAuthVersion Default ClientId ClientSecret UserName Password Scope AuthUrl https://some-domain.com/api/auth TokenUrl https://some-domain.com/api/token ReturnUrl https://zappysys.com/oauth ExtraAttributesForTokenRequest ExtraAttributesForAuthRequest RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True IgnoreSSLCertificateErrors SslVersion 
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read OData data in Power BI using ODBC
Importing OData data into Power BI from table or view
-
Once you open Power BI Desktop click Get Data to get data from ODBC:
-
A window opens, and then search for "odbc" to get data from ODBC data source:
-
Another window opens and asks to select a Data Source we already created. Choose OdataDSN and continue:
OdataDSN
-
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
OdataDSN
-
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, finally, use extracted data from OData in a Power BI report:
Importing OData data into Power BI using SQL query
If you wish to import OData data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.
SELECT
ProductID,
ProductName,
SupplierID,
CategoryID,
QuantityPerUnit,
UnitPrice
FROM Products
WHERE UnitPrice > 20
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - ODataOData Connector can be used to integrated any REST API which supports OData Standard. You can view tables, read data from tables using this connector. It also comes with some example OData Services to get started.OdataDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
OdataDSNDRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;URL=https://ignored;
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt - Our troubles are over! Now you should be able to use this connection string in Power BI with no problems.
Editing query for table in Power BI
There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:
Using parameters in Power BI (dynamic query)
In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.
To use a parameter in Power BI report, follow these simple steps:
-
Firstly, you need to Edit query of your table (see previous section)
-
Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:
= Odbc.Query("dsn=OdataDSN", "SELECT ProductID, ProductName, UnitPrice, UnitsInStock FROM Products WHERE UnitPrice > " & Text.From(MyParameter) & " ORDER BY UnitPrice")
Refer to Power Query M reference for more information on how to use its advanced features in your queries.
Using DirectQuery Option rather than Import
So far we have seen how to Import OData data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.
Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for OData data.
Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call OData via ZappySys Data Gateway.
- First read this article carefully, How to query OData API in SQL Server.
- Once linked server is configured we are ready to issue API query in Power BI.
- Click Get Data in Power BI, select SQL Server Database
- Enter your server name and any database name
- Select Mode as DirectQuery
-
Click on Advanced and enter query like below (we are assuming you have created OData Data Source in Data Gateway and defined linked server (Change name below).
SELECT * FROM OPENQUERY([ODATA_LINKED_SERVER], 'SELECT * FROM Customers')SELECT * FROM OPENQUERY([ODATA_LINKED_SERVER], 'SELECT * FROM Customers')
DirectQuery option for Power BI (Read OData Data Example using SQL Server Linked Server and ZappySys Data Gateway) - Click OK and Load data ... That's it. Now your OData API data is linked rather than imported.
Publishing Power BI report to Power BI service
Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:
-
First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:
-
Then select the Workspace you want to publish report to and hit Select button:
-
Finally, if everything went right, you will see a window indicating success:
If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.
Refreshing Power BI semantic model (dataset) using On-premises data gateway
Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:
- Standard Mode
- Personal Mode
Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.
Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.
We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.
Below you will find instructions on how to refresh semantic model using both types of gateways.
Refresh using On-premises data gateway (standard mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (standard mode):
-
Install On-premises data gateway (standard mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Register a new gateway (or migrate an existing one):
-
If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:
-
Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:
ODBC{"connectionstring":"dsn=OdataDSN"}
-
Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:
dsn=OdataDSN
In this example, we used the least restrictive Privacy level.If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.
On-premises data gateway (personal mode) does not have this limitation.
-
Proceed by choosing the newly created connection:
ODBC{"connectionstring":"dsn=OdataDSN"}
-
Finally, you are at the final step where you can refresh the semantic model:
Refresh using On-premises data gateway (personal mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (personal mode):
-
Install On-premises data gateway (personal mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:
dsn=OdataDSN
-
Finally, you are ready to refresh your semantic model:
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by OData Connector
OData Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.| Parameter | Description |
|---|---|
| TableName |
|
| Parameter | Description |
|---|---|
| TableName |
|
| Parameter | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Url |
|
||||||||||||||||||||||||||
| Body |
|
||||||||||||||||||||||||||
| IsMultiPart |
|
||||||||||||||||||||||||||
| Filter |
|
||||||||||||||||||||||||||
| Headers |
|
| Parameter | Description |
|---|---|
| Url |
|
| IsMultiPart |
|
| Filter |
|
| Headers |
|
OData Connector Examples for Power BI Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Read all records from an JSON OData Service Table [Read more...]
SELECT * FROM CustomersRead all records from an XML OData Service Table [Read more...]
SELECT * FROM read_data_xml WITH(TableName='MyTable')Filter records using server side criteria [Read more...]
SELECT * FROM Customers WITH( SearchCriteria='Country -eq ''USA'' ')Filter records using client side criteria [Read more...]
SELECT * FROM Customers WHERE Country = 'USA'List all Tables (JSON Based Format) [Read more...]
SELECT * FROM list_tables_jsonList all Tables (XML Based Format) [Read more...]
SELECT * FROM list_tables_xmlConclusion
In this article we discussed how to connect to OData in Power BI and integrate data without any coding. Click here to Download OData Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download OData Connector for Power BI
Documentation
More integrations
Other application integration scenarios for OData
Other connectors for Power BI
Download OData Connector for Power BI
Documentation
How to connect OData in Power BI?
How to get OData data in Power BI?
How to read OData data in Power BI?
How to load OData data in Power BI?
How to import OData data in Power BI?
How to pull OData data in Power BI?
How to push data to OData in Power BI?
How to write data to OData in Power BI?
How to POST data to OData in Power BI?
Call OData API in Power BI
Consume OData API in Power BI
OData Power BI Automate
OData Power BI Integration
Integration OData in Power BI
Consume real-time OData data in Power BI
Consume real-time OData API data in Power BI
OData ODBC Driver | ODBC Driver for OData | ODBC OData Driver | SSIS OData Source | SSIS OData Destination
Connect OData in Power BI
Load OData in Power BI
Load OData data in Power BI
Read OData data in Power BI
OData API Call in Power BI