Get Tiles

 

Updated: September 13, 2017


Request | Response

The Get Tiles operation returns a JSON list of all Tile objects which includes an id, title, and embedUrl, or a JSON list from a dashboard. All tile types are supported, except for "model tiles": which include datasets and live tiles that include an entire report page.

The Integrate a tile into an app walkthrough shows you how to get a tile in a dashboard to integrate, or embed, a tile into a web app.

Required scope: Tile.Read.All

GET https://api.powerbi.com/v1.0/myorg/dashboards/{dashboard_id}/tiles

Groups

Groups are a collection of unified Azure Active Directory groups that the user is a member of and is available in the Power BI service. These are referred to as app workspaces within the Power BI service. To learn how to create a group, see Create an app workspace.

GET https://api.powerbi.com/v1.0/myorg/groups/{group_id}/dashboards/{dashboard_id}/tiles

Uri parameter

NameDescriptionData Type
group_idGuid of the Group to use. You can get the group id from the Get Groups operation. Groups are referred to as app workspaces within the Power BI service.String
dashboard_idGuid of the Dashboard to use. You can get the Dashboard id from the Get Dashboards operation.String

Header

Authorization: Bearer eyJ0eX ... FWSXfwtQ

Status code

CodeDescription
200OK. Indicates success. The dataset is returned in the response body.

Content-Type

application/json

Body Schema

Tiles have a GUID id, title, and embedUrl. You use the embedUrl to embed a tile in an app. See Integrate a Power BI Tile.

Copy 
{  
  "@odata.context":"https://api.powerbi.com/v1.0/myorg/$metadata#tiles","value":  
  [  
    {         
      "id": "{tile_id}",
      "title": "{tile title}",
      "subTitle": "{tile subtitle}",
      "embedUrl": "https://app.powerbi.com/embed?dashboardId={dashboard_id}&tileId={tile_id}",
      "rowSpan": {integer},
      "colSpan": {integer},
      "reportId": "{report_id}",
      "datasetId": "{dataset_id}"
    }  
  ]  
}

Body Example

The following is an example of a JSON response with two tiles.

Copy 
{  
"@odata.context":"https://api.powerbi.com/v1.0/myorg/$metadata#tiles", "value":  
    [  
      {
        "id": "f16dc78a-464a-44d4-8502-afe1098a100d",
        "title": "ProductID",
        "subTitle": "",
        "embedUrl": "https://app.powerbi.com/embed?dashboardId=aec58412-464a-44d4-8502-a5a43dae0409&tileId=f16dc78a-464a-44d4-8502-afe1098a100d",
        "rowSpan": 0,
        "colSpan": 0,
        "reportId": "2ad498d1-3ae9-49f4-9826-9586afa3f835",
        "datasetId": "2e2e1cfb-701d-4ca3-86ea-d91780bfe63f"
      },  
      {
        "id": "9ab3925d-464a-44d4-8502-4d6c896df0c9",
        "title": "Count of CountryRegionCode",
        "subTitle": "",
        "embedUrl": "https://app.powerbi.com/embed?dashboardId=aec58412-464a-44d4-8502-a5a43dae0409&tileId=9ab3925d-464a-44d4-8502-4d6c896df0c9",
        "rowSpan": 0,
        "colSpan": 0,
        "reportId": "2ad498d1-3ae9-49f4-9826-9586afa3f835",
        "datasetId": "2e2e1cfb-701d-4ca3-86ea-d91780bfe63f" 
      }  
    ]  
}

Show: