Dashboards - Get Tile In Group
Returns the specified tile within the specified dashboard from the specified workspace.
Supported tiles include datasets and live tiles that contain an entire report page.
Permissions
This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.
Required Scope
Dashboard.ReadWrite.All or Dashboard.Read.All
Limitations
Titles that are edited in the report before the visual is added to the dashboard, are not returned. To return these titles, edit them in the dashboard.
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}/tiles/{tileId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
dashboard
|
path | True |
string uuid |
The dashboard ID |
group
|
path | True |
string uuid |
The workspace ID |
tile
|
path | True |
string uuid |
The tile ID |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
Examples
Example
Sample request
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b
Sample response
{
"id": "312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b",
"title": "SalesMarketingTile",
"embedUrl": "https://app.powerbi.com/embed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&tileId=312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
"rowSpan": 0,
"colSpan": 0,
"reportId": "5b218778-e7a5-4d73-8187-f10824047715",
"datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}
Definitions
Tile
A Power BI tile
Name | Type | Description |
---|---|---|
colSpan |
integer |
The number of tile span columns |
datasetId |
string |
The dataset ID. Available only for tiles created from a report or by using a dataset, such as Q&A tiles. |
embedData |
string |
The embed data for the tile |
embedUrl |
string |
The embed URL of the tile |
id |
string |
The tile ID |
reportId |
string |
The report ID. Available only for tiles created from a report. |
rowSpan |
integer |
The number of tile span rows |
title |
string |
The display name of the tile |