Admin - Dashboards GetDashboardsAsAdmin

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

Returns a list of dashboards for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
$expand
 query
  • string

Expands related entities inline, receives a comma-separated list of data types. Supported: tiles
$filter
 query
  • string

Filters the results, based on a boolean condition
$skip
 query
  • integer
int32

Skips the first n results
$top
 query
  • integer
int32

Returns only the first n results

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false
    }
  ]
}

Definitions

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.
Dashboards

Odata response wrapper for a Power BI dashboard collection
SensitivityLabel

Artifact sensitivity label info
Tile

A Power BI tile

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
dataClassification
  • string

The data classification tag of the dashboard
displayName
  • string

The dashboard display name
embedUrl
  • string

The dashboard embed url
id
  • string

The dashboard id
isReadOnly
  • boolean

Is ReadOnly dashboard
sensitivityLabel

The dashboard sensitivity label
tiles

The tiles that belong to the dashboard.

Dashboards

Odata response wrapper for a Power BI dashboard collection

Name Type Description
odata.context
  • string

OData context
value

The dashboard collection

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID

Tile

A Power BI tile

Name Type Description
colSpan
  • integer

number of columns a tile should span
datasetId
  • string

The dataset id. Available only for tiles created from a report or using a dataset; for example, Q&A tiles.
embedData
  • string

The tile embed data
embedUrl
  • string

The tile embed url
id
  • string

The tile id
reportId
  • string

The report id. Available only for tiles created from a report.
rowSpan
  • integer

number of rows a tile should span
title
  • string

The dashboard display name