Skip to main content

Microsoft Power BI

Microsoft Power BI connector for workspaces, reports, semantic models, dashboards, dataflows and tenant administration through the Power BI REST API.

Categories: Analytics, Business Intelligence, Productivity

What you can ask​

  • Refresh the Sales Pipeline semantic model and check the refresh history for failures
  • List every report in the Finance workspace and who has access to the workspace
  • Push rows into a push dataset for a live operations dashboard

Set up​

Microsoft Power BI needs an OAuth application from your organization before anyone can connect. An organization admin completes these steps once.

  1. Go to Organization > Connectors and find Microsoft Power BI. Click Enable, and choose which tools to allow.
  2. Create an OAuth application in the Microsoft Power BI developer portal.
  3. Add the Redirect URI shown in the connector settings to the application.
  4. Copy the application's Client ID and Client Secret into the connector, then save it.
  5. Each member connects their own account the first time they use it.

⚠️ Warning: Do not enter your Devs.ai or Microsoft Power BI login email or password in the OAuth application fields.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

OAuth scopes used by these tools (10)

Grant the scopes for the tools you plan to allow.

  • https://analysis.windows.net/powerbi/api/App.Read.All
  • https://analysis.windows.net/powerbi/api/Content.Create
  • https://analysis.windows.net/powerbi/api/Dashboard.ReadWrite.All
  • https://analysis.windows.net/powerbi/api/Dataflow.ReadWrite.All
  • https://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All
  • https://analysis.windows.net/powerbi/api/Gateway.Read.All
  • https://analysis.windows.net/powerbi/api/Report.ReadWrite.All
  • https://analysis.windows.net/powerbi/api/Tenant.Read.All
  • https://analysis.windows.net/powerbi/api/Workspace.Read.All
  • https://analysis.windows.net/powerbi/api/Workspace.ReadWrite.All

Tools​

Microsoft Power BI offers 42 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (30)​

View and search information without changing it.

ToolWhat it does
get_appGet one Power BI app by ID.
get_dashboardGet one dashboard by ID.
get_dataflowGet a Power BI (Gen1) dataflow's stored definition, containing its entities and Power Query expressions.
get_datasetGet one semantic model by ID.
get_dataset_datasourcesList the data sources a semantic model reads from, including the gateway serving each one.
get_gatewayGet one on-premises data gateway by ID.
get_importGet one import by ID to check its progress. import_state reads 'Publishing' while it runs and 'Succeeded' when the reports and semantic models it created become available.
get_refresh_historyList past and in-progress refreshes of a semantic model, newest first.
get_reportGet one report by ID, including the semantic model it reads from.
get_workspaceGet one Power BI workspace by ID.
list_admin_dashboardsList every dashboard in the tenant, across all workspaces.
list_admin_dataflowsList every dataflow in the tenant, across all workspaces.
list_admin_datasetsList every semantic model in the tenant, across all workspaces.
list_admin_reportsList every report in the tenant, across all workspaces.
list_admin_workspacesList every workspace in the tenant, including ones the account is not a member of.
list_app_dashboardsList the dashboards published inside a Power BI app.
list_app_reportsList the reports published inside a Power BI app.
list_appsList the Power BI apps the connected account can open.
list_dashboard_tilesList the tiles pinned to a dashboard, including the report and semantic model behind each one.
list_dashboardsList the dashboards in a Power BI workspace.
list_dataflowsList the Power BI (Gen1) dataflows in a workspace.
list_dataset_tablesList the table names in a push semantic model.
list_datasetsList the semantic models (datasets) in a Power BI workspace.
list_gateway_datasourcesList the data sources bound to an on-premises data gateway.
list_gatewaysList the on-premises data gateways the connected account can administer.
list_importsList the .pbix and Excel imports performed into a Power BI workspace, with the state of each.
list_reportsList the reports in a Power BI workspace.
list_workspace_usersList the users, groups and service principals with access to a Power BI workspace, and the access level each holds.
list_workspacesList the Power BI workspaces the connected account can open.
validate_credentialValidate Power BI credentials by reading the tenant's available features.

Write (7)​

Create or send data.

ToolWhat it does
add_workspace_userGrant a user, group or service principal access to a Power BI workspace.
clone_reportCopy a report, optionally into another workspace or onto another semantic model.
create_dashboardCreate an empty dashboard in a Power BI workspace.
create_push_datasetCreate a push semantic model from a table schema, with no .pbix file.
create_workspaceCreate a Power BI workspace.
push_rowsAppend rows to a table in a push semantic model.
refresh_datasetStart a refresh of a semantic model.

Delete or overwrite (5)​

Remove or replace existing data.

ToolWhat it does
delete_datasetDelete a semantic model and every report built on it.
delete_reportDelete a report from a Power BI workspace.
delete_workspaceDelete a Power BI workspace and everything inside it.
remove_workspace_userRevoke a principal's access to a Power BI workspace.
truncate_tableDelete every row from a table in a push semantic model, leaving the table and its schema in place.
⌘J