Power BI Connector for PythonConnect to your Power BI account and retrieve data, refresh datasets, etc. In this article you will learn how to quickly and efficiently integrate Power BI data in Python. We will use high-performance Power BI Connector to easily connect to Power BI and then access the data inside Python. Let's follow the steps below to see how we can accomplish that! Power BI Connector for Python is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Power BI in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Power BI using Python we first need to create a DSN (Data Source) which will access data from Power BI. We will later be able to read data using Python. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Power BI" from the list of Popular Connectors. If "Power BI" 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:
PowerBiDSNPower BI -
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.
Use delegated access (User Credentials) whenever you want to let a signed-in user work with their own resources or resources they can access. Whether it's an admin setting up policies for their entire organization or a user deleting an email in their inbox, all scenarios involving user actions should use delegated access. [API reference]
Steps how to get and use Power BI credentials : User Credentials [OAuth]
Follow these simple steps below to create Microsoft Entra ID application with delegated access:
WARNING: If you are planning to automate processes, we recommend that you use a Application Credentials authentication method. In case, you still need to use User Credentials, then make sure you use a system/generic account (e.g.automation@my-company.com
). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.- Navigate to the Azure Portal and log in using your credentials.
- Access Microsoft Entra ID.
-
Register a new application by going to App registrations and clicking on New registration button:
INFO: Find more information on how to register an application in Graph API reference. -
When configuration window opens, configure these fields:
-
Supported account type
- Use
Accounts in this organizational directory only
, if you need access to data in your organization only.
- Use
-
Supported account type
-
Redirect URI:
- Set the type to
Public client/native (mobile & desktop)
. - Use
https://zappysys.com/oauth
as the URL.
- Set the type to
-
After registering the app, copy the Application (client) ID for later:
-
Copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration:
-
Now go to SSIS package or ODBC data source and use the copied values in User Credentials authentication configuration:
- In the Authorization URL field paste the OAuth authorization endpoint (v2) URL value you copied in the previous step.
- In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
- In the Client ID field paste the Application (client) ID value you copied in the previous step.
-
In the Scope field use the default value or select individual scopes, e.g.:
-
offline_access
-
https://analysis.windows.net/powerbi/api/Workspace.Read.All
-
https://analysis.windows.net/powerbi/api/Dataset.Read.All
-
https://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All
-
- Press Generate Token button to generate Access and Refresh Tokens.
- Click Test Connection to confirm the connection is working.
- Optional step. Choose Default Workspace from the drop down menu.
- Choose Default Dataset from the drop down menu.
- Done! Now you are ready to use the API Connector!
Fill in all required parameters and set optional parameters if needed:
PowerBiDSNPower BIUser Credentials [OAuth]https://api.powerbi.com/v1.0/myorgRequired Parameters Authorization URL Fill-in the parameter... Token URL Fill-in the parameter... Client ID Fill-in the parameter... Scope Fill-in the parameter... Default Dataset (select after generating tokens) Fill-in the parameter... Optional Parameters Client Secret Redirect URI (must match App Redirect URI) Default Workspace (Keep Empty for My Workspace - select after generating tokens) RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 20 RetryWaitTimeMs 1000 RetryMultiplyWaitTime True Login options -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - Power BIConnect to your Power BI account and retrieve data, refresh datasets, etc.PowerBiDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Python to retrieve data from Power BI. Hit OK button to use this query in the next step.
SELECT * FROM Workspaces WHERE Id='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
Some parameters configured in this window will be passed to the Power BI API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Python:
ZappySys API Driver - Power BIConnect to your Power BI account and retrieve data, refresh datasets, etc.PowerBiDSNSELECT * FROM Workspaces WHERE Id='aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Power BI API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Power BI servers). -
Click OK to finish creating the data source.
Video Tutorial
Read data in Python
Using ODBC DSN
-
Python code to get the data:
PowerBiDSN') -
When you run the code it will make the API call and read the data:
-
Here is Python program's code in text format:
import pyodbc conn = pyodbc.connect('DSN=PowerBiDSN') cursor = conn.cursor() #execute query to fetch data from API service cursor.execute("SELECT id,title FROM products") row = cursor.fetchone() while row: print(row) row = cursor.fetchone() ##For loop example #for row in cursor: # print(row)
Using a full ODBC connection string
If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - Power BIConnect to your Power BI account and retrieve data, refresh datasets, etc.PowerBiDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then in your Python code use Connection String when initializing OdbcConnection object, for example:
conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')
How to install `pyodbc` in the Python?
You would need to install pyodbc
in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc
in Python:
Installation Steps:
Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
-
Use the following command to install
pyodbc
using pip, the Python package installer:python -m pip install "pyodbc"
Make sure you have a stable internet connection and the necessary permissions to install Python packages.
Reasons to Install:
- If pyodbc is not installed, your Python script will generate the following error:
"ModuleNotFoundError: No module named 'pyodbc'"
. Database Connectivity:
pyodbc
allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support:
pyodbc
is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.
By installing pyodbc
, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.
Actions supported by Power BI Connector
Learn how to perform common Power BI actions directly in Python with these how-to guides:
- Create a Push Dataset
- Delete a Dataset
- Execute a DAX query
- Get a Dataset
- Get a Workspace
- Get Datasets
- Get Table Columns
- Get Table Rows
- Get Tables
- Get Workspaces
- Insert Rows into Push Dataset Table
- Refresh a Dataset
- Truncate a Push Dataset Table
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Power BI in Python and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Power BI, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Power BI Connector for Python and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Power BI Connector for Python Documentation
More integrations
Other connectors for Python
Other application integration scenarios for Power BI
How to connect Power BI in Python?
How to get Power BI data in Python?
How to read Power BI data in Python?
How to load Power BI data in Python?
How to import Power BI data in Python?
How to pull Power BI data in Python?
How to push data to Power BI in Python?
How to write data to Power BI in Python?
How to POST data to Power BI in Python?
Call Power BI API in Python
Consume Power BI API in Python
Power BI Python Automate
Power BI Python Integration
Integration Power BI in Python
Consume real-time Power BI data in Python
Consume real-time Power BI API data in Python
Power BI ODBC Driver | ODBC Driver for Power BI | ODBC Power BI Driver | SSIS Power BI Source | SSIS Power BI Destination
Connect Power BI in Python
Load Power BI in Python
Load Power BI data in Python
Read Power BI data in Python
Power BI API Call in Python