Power BI Rest API – Dashboard, Embed Token, Gateways, Group

1. Power BI Rest API  – Objective

In our last, we discussed Power BI Admin APIs. Here, in this part of Power BI REST API, we will cover next 3 API: Power BI Dashboard API, Power BI Embed Token API, Power BI Gateways API, and Power BI Group API with their subcategories.
So, let’s start Power BI REST API Tutorial.

Power BI Rest API – Dashboard, Embed Token, Gateways, Group

2. Power BI Rest API

These are the Power BI REST API/Operation groups:

• Operation group Description
• Admin Operations
• Available Features
• Capacities Operations
• Dashboards Operations
• Embed Token Operations
• Gateways Operations
• Groups Operations
• Imports Operations
• Push Datasets Operations
• Reports Operations
• Datasets Operations

3. Power BI Dashboard API

This is the most important Power BI REST API.

a. Include Dashboard

Makes another vacant dashboard on “My Workspace”.
Required Extension: Content.Create

b. Include Dashboard In Group

Makes another vacant dashboard on the predefined workspace.
Required Degree: Content.Create
Do you know How to Create Power BI Dashboard?

c. Clone Tile

Clones the predetermined tile from “My Workspace”.
On the off chance that objective report id and target dataset are not determined, the accompanying can happen:

• At the point when a tile clone is performed inside a similar workspace, the report and dataset connections will be cloned from the source Tile.
• When cloning a tile inside an alternate workspace, report and dataset connections will be refreshed, and the tile will be broken.

Required Extension: Dashboard.ReadWrite.All

d. Clone Tile In Group

Clones the predefined tile from the predetermined workspace.
In the event that objective report id and target dataset are feeling the loss of, the accompanying can happen:

• At the point when a tile clone is performed inside a similar workspace, the report and dataset connections will be cloned from the source tile.
• On the off chance that you are cloning a tile inside an alternate workspace, report and dataset connections will be refreshed. The tile will be broken.

Required Extension: Dashboard.ReadWrite.All

e. Get Dashboard

Returns the predefined dashboard from “My Workspace”.
Required Extension: Dashboard.ReadWrite.All or Dashboard.Read.All

f. Get Dashboard In Group

Returns the predetermined dashboard from the predefined workspace.
Required Degree: Dashboard.ReadWrite.All or Dashboard.Read.All

g. Get Dashboards

Returns a rundown of dashboards from “My Workspace”.
Required Extension: Dashboard.ReadWrite.All or Dashboard.Read.All

h. Get Dashboards In Group

Returns a rundown of dashboards from the predefined workspace.
Required Degree: Dashboard.ReadWrite.All or Dashboard.Read.All

i. Get Tile

Returns the predetermined tile inside the predefined dashboard from “My Workspace”.
Note: All tile composes are upheld with the exception of “show tiles”, which incorporate datasets and live tiles that contain a whole report page.
Required Extension: Dashboard.ReadWrite.All or Dashboard.Read.All
Read about Power BI View Dashboard & Report on Mobile, Tab, PC

j. Get Tile In Group

Returns the predefined tile inside the predetermined dashboard from the predefined workspace.
Note: All tile composes are bolstered with the exception of “display tiles”, which incorporate datasets and live tiles that contain a whole report page.
Required Extension: Dashboard.ReadWrite.All or Dashboard.Read.All

k. Get Tiles

Returns a rundown of tiles inside the predefined dashboard from “My Workspace”.
Note: All tile composes are bolstered aside from “display tiles”, which incorporate datasets and live tiles that contain a whole report page.
Required Extension: Dashboard.ReadWrite.All or Dashboard.Read.All

l. Get Tiles In Group

Returns a rundown of tiles inside the predefined dashboard from the predetermined workspace.
Note: All tile composes are upheld with the exception of “demonstrate tiles”, which incorporate datasets and live tiles that contain a whole report page.
Required Degree: Dashboard.ReadWrite.All or Dashboard.Read.All
Follow this link to know How to Share Power BI Dashboard(Outside Organization/Clients)

4. Power BI Embed Token API

Power BI REST API – Embed Token
a. Dashboards GenerateToken
This usefulness is just accessible in a workspace setting. Utilize Dashboards GenerateTokenInGroup.
b. Dashboards GenerateTokenInGroup
Creates an implant token to see the predetermined dashboard from the predefined workspace.
This Power BI Rest API is pertinent just to ‘Application claims information’ install situation.
Required Degree: The majority of the beneath

• Dashboard.ReadWrite.All or Dashboard.Read.All
• Report.ReadWrite.All or Report.Read.All
• Dataset.ReadWrite.All or Dataset.Read.All

c. Datasets GenerateTokenInGroup
Produces an install token to Embed Q&A in view of the predetermined dataset from the predefined workspace.
This Power BI REST API is pertinent just to ‘Application claims information’ install situation.
Required Degree: Dataset.ReadWrite.All or Dataset.Read.All
d. Reports GenerateToken
This usefulness is just accessible in a workspace setting. Utilize Reports GenerateTokenInGroup.
e. Reports GenerateTokenForCreate
This usefulness is just accessible in a workspace setting. Utilize Reports GenerateTokenForCreateInGroup.
f. Reports GenerateTokenForCreateInGroup
Produces an insert token to permit report creation on the predetermined workspace in light of the predefined dataset.
This Power BI REST API is applicable just to ‘Application possesses information’ install situation.
Required Extension: The greater part of the beneath

• Content.Create
• Report.ReadWrite.All or Report.Read.All
• Dataset.ReadWrite.All or Dataset.Read.All

Have a look at Power BI Report Server
g. Reports GenerateTokenInGroup
Creates an implant token to see or alter the predefined report from the predetermined workspace.
This API is pertinent just to ‘Application possesses information’ insert situation.
Required Degree: The greater part of the underneath

• Report.ReadWrite.All or Report.Read.All

• Dataset.ReadWrite.All or Dataset.Read.All

• Content.Create – Required just if allowSaveAs indicated in GenerateTokenRequest

h. Tiles GenerateToken
This usefulness is just accessible in a workspace setting. Utilize Tiles GenerateTokenInGroup.
i. Tiles GenerateTokenInGroup
Produces an install token to see the predetermined tile from the predefined workspace.
This Power BI REST API is important just to ‘Application possesses information’ implant situation.
Required Extension: The greater part of the underneath.

• Dashboard.ReadWrite.All or Dashboard.Read.All

• Report.ReadWrite.All or Report.Read.All

• Dataset.ReadWrite.All or Dataset.Read.All

Let’s discuss the Working with Table in Power BI Dashboards & Reports

5. Power BI Gateways API

Power BI Rest API – Gateways API
a. Add Datasource User
Grants the specified user the permissions required to use the specified datasource.
Required Scope: Dataset.ReadWrite.All
b. Create Datasource
On the Specified gateway create a new datasource
Required Scope: Dataset.ReadWrite.All
Do you know What is Power BI Gateway?
c. Delete Datasource
Deletes the specified datasource from the specified gateway.
Required Scope: Dataset.ReadWrite.All
d. Delete Datasource User
Removes the specified user from the specified datasource.
Required Scope: Dataset.ReadWrite.All
e. Get Datasource By Id
Returns the specified datasource from the specified gateway.
Required Scope: Dataset.ReadWrite.All or Dataset.Read.All
f. Get Datasources
Returns a list of datasources from the specified gateway.
Required Scope: Dataset.ReadWrite.All or Dataset.Read.All
g. Get Datasource Status By Id
Checks the connectivity status of the specified datasource from the specified gateway.
Required Scope: Dataset.ReadWrite.All
h. Get Datasource Users
Returns a list of users who have access to the specified datasource.
Required Scope: Dataset.ReadWrite.All or Dataset.Read.All
Have a look at – Power BI Conditional Formatting
i. Get Gateway By Id
Returns the specified gateway.
Required Scope: Dataset.ReadWrite.All or Dataset.Read.All
j. Get Gateways
Returns a list of gateways for which the user is an admin.
Required Scope: Dataset.ReadWrite.All or Dataset.Read.All
k. Update Datasource
Updates the credentials of the specified datasource from the specified gateway.
To get the gateway and datasource ids for a dataset, use Get Datasources or Get Datasources In Group
Required Scope: Dataset.ReadWrite.All

6. Power BI Group API

Power BI REST API – Group API
a. Include Group User
Stipends the predefined client consents to the predetermined workspace.
Note: Only Admin get to the right is upheld.
Required Degree: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
b. Make Group
Makes new workspace.
Required Degree: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
Do you know the difference between SSRS Vs Power BI
c. Erase Group
Erases the predetermined workspace.
Required Degree: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
d. Erase User In Group
Erases the predetermined client authorizations from the predefined workspace.
Required Degree: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
e. Get Groups
Returns a rundown of workspaces the client approaches.
Required Extension: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
f. Get Group Users
Returns a rundown of clients that approach the predefined workspace.
Required Extension: Group.Read.All or Group.ReadWrite.All or Workspace.Read.All or Workspace.ReadWrite.All
Follow this link to know about Power BI Admin Portal
So, this was all about Power BI REST API Tutorial. Hope you like our explanation.

7. Conclusion

Hence, we discussed the four Power BI REST API are: Power BI Dashboard API, Power BI Embed Token API, Power BI Gateways API, and Power BI Group API with their subcategories. Stay tuned more last part of APIs. If you wanna share information, feel free to share with us!
Related Topic – Relationship in Power BI
For reference