Skip to main content

Simplify usage of Power Bi Rest API

Project description


This is a simple library that makes it easy to use the Power Bi REST API. One day SimplePBI will contain all the categories in the API (Admin, datasets, reports, etc). Feel free to check the doc to get a deeper understanding of a specific request:
We are doing our best to make this library useful for the community. This project is not a remunerable job for us. It's a public community project. Please be patient if you submit an issue and it's not fixed right away. It's a way to express our passion of sharing knowledge.
Each category is an Object. This means we need to initialize an object to start using its methods. In order to create them we need the Bearer token that can be obtain from a Token Object. Let's see how we can create an Admin Object to try the requests in that category.

# Import library
from simplepbi import token
from simplepbi import admin

We always need to import token object to create the object to run requests. Then we can pick the object of the Power Bi Rest API category we need. For instance "admin". The token can be created in two ways, the regular authentication and the service principal one. It depends which one you pick to complete the request. These are the necessary arguments to get a token:

  • tenant_id (you can get it from subscription resource in azure portal or ask for it to the IT department)
  • app_client_id (your app_id/client_id from the App registered in Azure with permissions to Power Bi Service)
  • username (professional email account in Azure AD)
  • password (professional password)
  • app_secret_key (secret key generated for the client id)
  • use_service_principal (True to athenticate with Service Principal and False to continue with user credentials)

NOTE: if you want to use service principal, be sure to have your tenant ready for that.
Register app example:
Service Principal permissions for admin api:

# Creating objects

#Regular Login
tok = token.Token(tenant_id, app_client_id, username, password, None, use_service_principal=False)

#Service Principal
tok = token.Token(tenant_id, app_client_id, None, None, app_secret_key, use_service_principal=True)

ad = admin.Admin(tok.token)

As you can see the Token object contains a token attribute with the Bearer used by Azure to run rest methods. That attribute will be user to create the category objects like admin. Once we create our Object like admin, we can start using the requests adding the correct parameters if they are needed.

# Getting objects

All_Datasets = ad.get_datasets()

Datasets_In_Groups = ad.get_datasets_in_group(workspace_id)

The library get requests will return a response object .json() that python reads it as a Dict.

Preview methods

There are some methods in the classes that still need more testing. Those will have a "preview" at the end of the name. Please let us know if something goes wrong with those.

Current Categories

Right now the library is consuming endpoints from:

Complex requests

If you want to get a deeper look on complex Admin methods and unique methods. Check this doc

Azure Pause Resume Resources

We have added a new feature to include some Azure Resource API Manager. The new "azpause" class will let you Pause or Resume Azure tabular or capacity resources. With SimplePBI you can pause and resume Fabric, Power Bi Embedded or Azure Analysis Services resources. Check this doc

Additional content

There an aditional library Utils for transformations. It is used to help some requests returning different values. The most useful method in the Utils class might be to_pandas. You can use the method to convert simple dicts to pandas. It needs the dict and the key father of a list of dicts in the response. The usual get responses are using "value" as the key. We are also adding new methods with the requests to help get new actions. Examples:

Example of our amazing unique requests

  • get_orphan_dataflows_preview: get dataflows without dataset
  • simple_import_pbix: makes publishing a pbix file easier
  • simple_import_pbix_as_parameter: import a pbix from api response content
  • simple_import_pbix_folder_in_group_preview: post a all pbix files in a local folder
  • simple_import_from_devops: import a pbix from azure devops repo
  • simple_import_from_github: import a pbix from azure github repo
  • simple_copy_reports_between_groups: copy report from workspace to a workspace
  • enhanced_refresh_dataset_in_group: a special request feature that not only eliminates the need for synchronous client connections to perform a refresh, but also unlocks enterprise-grade refresh capabilities.
  • get_activity_events_preview (already iterating): makes the get activity events specified by date easier
  • get_user_artifact_access_preview (already iterating): makes the get user artifact access easier
  • get_widely shared_artifacts_published_to_web (already iterating): makes geting the published to web repos info easier

Small categories

Small categories like Dataflow Storage Accounts and Available Features were moved to Groups and Admin.

Missing endpoints

We are still developing the library. The following endpoints from admin are still missing


  • Set and Remove LabelsAsAdmin


  • Update group User


  • Export To File (full request, there is a smaller simpler one)
  • Get Export To File Status (regular and in groups)
  • Get File Of Export To File (regular and in groups)
  • Update Datasources (rdl files regular and in groups)
  • Update Report Content (regular and in groups)


  • Create Temporary Upload Location
  • Create Temporary Upload Location In Group
  • Post Import (for xlsx, json and rdl)
  • Post Import In Group (for xlsx, json and rdl)


  • Create Datasource (looks like there is a bug on the API)
  • Update Datasource
  • Delete Datasource

Scorecards (preview)

  • Patch By Id
  • Move Goals

Embed Token

  • All requests

Goals (preview)

  • All requests

Next Steps (planned items)

  • Keep completing missing endpoints category.
  • Creating new awesome ideas.
  • Analyzing how to include embeding and pushing dataset requests.

Change Log

0.0.1 (04/09/2021)

  • First Commit

0.0.2 (29/10/2021)

  • Completing almost all the requests in Admin Section

0.0.3 (14/11/2021)

  • Creating aditional content to admin and adding first commit for groups and datasets category

0.0.4 (15/11/2021)

  • Repo/source going public. Adding datasets and groups Power Bi Rest API category.

0.0.5 (16/11/2021)

  • Fixing error handling. Adding dataflows Power Bi Rest API category

0.0.6 (29/11/2021)

  • Fixing install module issues

0.0.7 (29/11/2021)

  • Fixing datasets for dax queries

0.0.8 (29/11/2021)

  • Fixing typo for dax queries avoiding nulls

0.0.9 (04/01/2022)

  • Adding new preview requests for subscriptions in Admin category. Those released this month by Power Bi.

0.0.10 (18/01/2022)

  • Adding all dashboards requests and 80% of reports requests.

0.0.11 (08/04/2022)

  • Adding widely shared artifacts requests for admin category.
  • Adding App category requests.
  • Adding "get" requests from import category.

0.0.12 (20/05/2022)

  • Fixing reports bugs and adding export to file as preview
  • Adding post import file to workspace (only pbix files of less than 1gb)

0.0.13 (27/05/2022)

  • Updating Import request ExecuteQueries with the new update from Microsoft making it GA.
  • Creating a new method to import all pbix files in an specified local folder to a workspace

0.0.14 (27/07/2022)

  • Adding almost all gateway category requests
  • Adding new special request from ladataweb. Migrating reports between workspaces. Importing pbix files from Reponse.Content requests library to a Power Bi Service Workspace

0.0.15 (08/08/2022)

  • Adding capacities category requests.
  • Fixing descriptions

0.1.0 (03/10/2022)

  • Adding pipelines and scorecards category requests.
  • All componentes category are now available with a little missing endpoints
  • Completing at least 80% of request for all most frequent items at Power Bi. The only categories unavailables are push datasets and embedding.
  • Bug fixing requests

0.1.1 (30/01/2023)

Minor bug fixing for imports to read filesystem

0.1.2 (14/02/2023)

Improving get activity events for single day after PowerBi updates. Adding new request to get last 30 days of activity logs automatically.

0.1.3 (08/05/2023)

Adding update sources for datasets. It's a complex body request. Adding new unique request for publishing pbix file from azure devops repo. Changing pandas coding to work with 2.0.1 version. Fixing deprecated methods.

0.1.4 (30/06/2023)

Adding newest admin request for getting tenant settings Adding new unique requests for pausing and resuming Fabric, Power Bi Embedded and Azure Analysis Services.

0.1.5 (19/09/2023)

Adding dataset requests for scaleout. Update dataset to turn it on, get query sync and trigger query scale out sync.

0.1.6 (24/10/2023)

Filtering Activity Events. The request methods for getting Activity Events for a single day or the last 30 days can now filter by user or activity.

0.1.7 (16/12/2023)

Fixing request for importing powerbi desktop file from Azure DevOps.

0.1.8 (25/03/2024)

Adding new request for importing pbix from GitHub (less 1Mb) like the one for DevOps. New Object category. Adding all Push Dataset category requests.

0.1.9 (12/05/2024)

Adding support for GitHub pbix importing up to 100Mb.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

SimplePBI-0.1.9-py3-none-any.whl (60.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page