Admin - Dashboards GetTilesAsAdmin

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Returns a list of tiles within the specified dashboard.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

When running under service prinicipal authentication, an app must not have any admin-consent required premissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

Limitations

Maximum 200 requests per hour. 

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

URI Parameters

Name In Required Type Description
dashboardId
 path True
  • string
uuid

The dashboard ID

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles

Sample Response

Status code:
200 
{
  "value": [
    {
      "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",
      "rowSpan": 0,
      "colSpan": 0,
      "reportId": "5b218778-e7a5-4d73-8187-f10824047715",
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

Definitions

AdminTile

A Power BI tile returned by Admin APIs.
AdminTiles

The OData response wrapper for a Power BI tile collection

AdminTile

A Power BI tile returned by Admin APIs.

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

AdminTiles

The OData response wrapper for a Power BI tile collection

Name Type Description
odata.context
  • string

OData context
value

The tile collection