Microsoft Power BI
Prev  Business Intelligence  Next

Microsoft Power BI

The Microsoft Power BI modules allow you to monitor, create, update, send, retrieve, list, and delete the apps, dashboards and reports in your Microsoft Power BI account.

Getting Started with Power BI

Prerequisites

[Note] Note

The module dialog fields that are displayed in bold (in the {{Make}} scenario, not in this documentation article) are mandatory.
Connecting Microsoft Power BI to {{Make}}

  1. Go to {{Make}} and open the Microsoft Power BI module's Create a connection dialog.

    61d6a5d5a4999.gif

  2. In the Connection name field, enter a name for the connection and click Continue.

  3. Select the account to establish the connection.

    61d6a5d889439.png

  4. Confirm the access by clicking the Accept button.

    61d6a5d9a41af.png

The connection has been established.

Dashboard
List Dashboards

Retrieves a list of dashboards.

Connection

Establish a connection to your Microsoft Power BI account.

Group ID

Select or map the Group ID whose dashboards you want to list.

Limit

Set the maximum number of dashboards {{Make}} should return during one execution cycle.
List Dashboard Tiles

Retrieves a list of dashboard tiles.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Dashboard ID

Select or map the option to choose the dashboard whose tiles you want to list.

Dashboard ID

Enter (map) the Dashboard ID whose tiles details you want to list.

Group ID

Select or map the Group ID whose dashboard tiles you want to list.

Limit

Set the maximum number of dashboard tiles {{Make}} should return during one execution cycle.
Get a Dashboard

Gets metadata of a specified dashboard.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Dashboard ID

Select or map the option to choose the dashboard details you want to retrieve.

Dashboard ID

Enter (map) the Dashboard ID whose details you want to retreive.

Group ID

Select or map the Group ID whose details you want to retrieve.
Get a Dashboard Tile

Gets metadata of a specified dashboard tile.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Dashboard ID

Select or map the option to choose the dashboard details you want to retrieve.

Dashboard ID

Enter (map) the Dashboard ID whose details you want to retreive.

Tile ID

Enter (map) the Power BI Tile ID whose details you want to retrieve.

Group ID

Enter (map) the Group ID to which the tile belongs.
Create a Dashboard

Creates a new dashboard.

Connection

Establish a connection to your Microsoft Power BI account.

Name

Enter (map) a name for the dashboard.

Group ID

Select or map the Group ID to which the dashboard belongs.
Report
List Report

Retrieves a list of reports.

Connection

Establish a connection to your Microsoft Power BI account.

Group ID

Select or map the Group ID whose reports you want to list.

Limit

Set the maximum number of reports {{Make}} should return during one execution cycle.
Get a Report

Gets metadata of a specified report.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Report ID

Select or map the option to select the report whose details you want to retrieve.

Report ID

Enter (map) the Report ID whose details you want to retrieve.

Group ID

Select or map the Group ID to which the report belongs.
Copy a Report

Copies an existing report.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Report ID

Select or map the option to select the Report ID you want to copy.

Group ID

Select or map the Group ID whose reports belong.

New Copied Report Name

Enter (map) a new name for the copied report.
Delete a Report

Deletes a report.

Connection

Establish a connection to your Microsoft Power BI account.

Report ID

Enter (map) the Report ID you want to delete.

Group ID

Select or map the Group ID whose reports you want to list.
Dataset
List Datasets

Retrieves a list of datasets.

Connection

Establish a connection to your Microsoft Power BI account.

Group ID

Select or map the Group ID whose datasets you want to list.

Limit

Set the maximum number of datasets {{Make}} should return during one execution cycle.
Get a Dataset

Gets metadata of a specified dataset.

Connection

Establish a connection to your Microsoft Power BI account.

Dataset ID

Select or map the Dataset ID whose details you want to retrieve.

Group ID

Select or map the Group ID to which the dataset belongs.
Create a Dataset

Creates a new dataset.

Connection

Establish a connection to your Microsoft Power BI account.

Name

Enter (map) a name for the dataset.

Group ID

Enter (map) a group a for the dataset.

Default Mode

Select or map the default mode for the dataset:

  • As Azure - A dataset with a live connection to Azure Analysis Service

  • As on Prem - A dataset with a live connection to On-premise Analysis Service

  • Push - A dataset that allows programmatic access for pushing data into PowerBI

  • Push Streaming - A dataset that supports data streaming and allows programmatic access for pushing data into Power BI

  • Streaming - A dataset that supports data streaming

Tables

Add the tables to the dataset:

Name

Enter (map) a table name.

Columns

Add the columns:

Name Enter (map) a column name.

Data Type Select or map the data type:

  • String

  • Integer

  • Boolean

  • Date Time

Format String Enter (map) the format string.

Rows

Enter (map) a Row ID details.

Measures

Add the measure for the tables.

Data Sources

Add the data sources:

Database

Enter (map) the database

Server

Enter (map) the server name.

URL

Enter (map) the URL address

Datasource ID

Enter (map) the Datasource ID.

Datasource Type

Select or map the data source type. For example, SQL.

Gateway ID

Enter (map) the Gateway ID

Default Retention Policy

Select or map the intentional policy for the dataset:

  • None

  • Basic FIFO

Add/Delete Rows in a Dataset Table

Adds or deletes rows of a specified push dataset table.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Table

Select or map the option to select the dataset you want to refresh.

Dataset ID

Enter (map) the Dataset ID whose rows you want to add or delete.

Table Name

Enter (map) the table name whose rows you want to add or delete.

Group ID

Enter (map) the Group ID name to which the dataset belongs.

Select the Action

Select or map the action you want to perform:

  • Add rows

  • Delete All Rows

Rows

Add the row fields: Key Enter (map) the key name. Field Type Select or map the field type:

  • Boolean

  • Date

  • Text

  • Number

Value Enter (map) the key value.
Refresh a Dataset

Refreshes a specified dataset.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Dataset

Select or map the option to select the dataset you want to refresh.

Dataset ID

Enter (map) the Dataset ID you want to refresh.

Group ID

Enter (map) the Group ID to which the dataset belongs.

Notify Option

Select or map the option to notify:

  • Mail on Completion

  • Mail on Failure

  • No Notification

Delete a Dataset

Deletes a dataset.

Connection

Establish a connection to your Microsoft Power BI account.

Enter a Dataset

Select or map the option to select the dataset you want to delete.

Dataset ID

Enter (map) the Dataset ID you want to delete.

Group ID

Enter (map) the Group ID to which the dataset belongs.
App
Watch Apps

Triggers when an app is last updated.

Connection

Establish a connection to your Microsoft Power BI account.

Limit

Set the maximum number of apps {{Make}} should return during one execution cycle.
List Apps

Retrieves a list of all apps installed.

Connection

Establish a connection to your Microsoft Power BI account.

Limit

Set the maximum number of apps {{Make}} should return during one execution cycle.
List App's Reports

Retrieves a list of reports from the specified app.

Connection

Establish a connection to your Microsoft Power BI account.

App ID

Select or map the App ID whose reports you want to list.

Limit

Set the maximum number of app reports {{Make}} should return during one execution cycle.
List App's Dashboards

Retrieves a list of dashboards from a specified app.

Connection

Establish a connection to your Microsoft Power BI account.

App ID

Select or map the App ID whose dashboards you want to list.

Limit

Set the maximum number of dashboards {{Make}} should return during one execution cycle.
Get an App

Gets metadata of a specified app.

Connection

Establish a connection to your Microsoft Power BI account.

App ID

Select or map the App ID whose details you want to retrieve.
Get an App's Report

Gets metadata of a specified app's report.

Connection

Establish a connection to your Microsoft Power BI account.

App ID

Select or map the App ID whose report details you want to retrieve

Report ID

Select or map the Report ID whose details you want to retreive.
Get an App's Dashboard

Gets metadata of a specified app's dashboard.

Connection

Establish a connection to your Microsoft Power BI account.

App ID

Select or map the App ID whose dashboard details you want to retrieve

Dashboard ID

Select or map the Dashboard ID whose details you want to retreive.
Other
Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Microsoft Power BI account.

URL

Enter a path relative to https://api.powerbi.com For example, /v1.0/myorg/datasets

For the list of available endpoints, refer to the Microsoft Power BI API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.
Example of Use - List Datasets

The following API call returns all the datasets from your Microsoft Power BI account:

URL: /v1.0/myorg/datasets

Method: GET

61d6a5dadf8f6.png

Matches of the search can be found in the module's Output under Bundle > Body > value. In our example, 4 datasets were returned:

61d6a5dc2c268.png
Permissions Information for Microsoft Power BI

  • Add/Delete Rows in a Dataset Table: Dataset.ReadWrite.All, Workspace.Read.All

  • Copy a Report: Report.Read.All, Workspace.Read.All, Content.Create

  • Create a Dashboard: Dashboard.Read.All, Content.Create, Workspace.Read.All

  • Create a Dataset: Dataset.ReadWrite.All, Workspace.Read.All

  • Delete a Dataset: Dataset.ReadWrite.All, Workspace.Read.All

  • Delete a Report: Report.ReadWrite.All, Workspace.Read.All

  • Get a Dashboard: Dataset.Read.All, Workspace.Read.All

  • Get a Dashboard Tile: Dashboard.Read.All, Workspace.Read.All

  • Get a Dataset: Dataset.Read.All, Workspace.Read.All

  • Get an App: App.Read.All

  • Get an App’s Dashboard: Dashboard.Read.All, App.Read.All

  • Get an App’s Report: Report.Read.All, App.Read.All

  • Get a Report: Report.Read.All, App.Read.All

  • List Apps: App.Read.All

  • List App’s Dashboards: Dashboard.Read.All, App.Read.All

  • List App’s Reports: Report.Read.All, App.Read.All

  • List Dashboards: Dashboard.Read.All, Workspace.Read.All

  • List Dashboard Tiles: Dashboard.Read.All, Workspace.Read.All

  • List Datasets: Dataset.Read.All, Workspace.Read.All

  • List Dataset Users: Dataset.Read.All, Workspace.Read.All, Tenant.Read.All

  • List Reports: Report.Read.All, Workspace.Read.All

  • Make an API Call: Dataset.ReadWrite.All, Workspace.ReadWrite.All, Dashboard.ReadWrite.All, Report.ReadWrite.All, Capacity.ReadWrite.All, Dataflow.ReadWrite.All, App.Read.All

  • Refresh a Dataset: Dataset.ReadWrite.All, Workspace.Read.All

  • Watch Apps: App.Read.All

Prev  Up  Next
Infinity  Home  Mixpanel