Admin - Dashboards GetDashboardsAsAdmin

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.
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
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

$top
query
  • integer
int32

Returns only the first n results

$skip
query
  • integer
int32

Skips 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

{
  "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

Dashboards

Odata response wrapper for a Power BI dashboard collection

Tile

A Power BI tile

Tiles

Odata response wrapper for a Power BI tile collection

Dashboard

A Power BI dashboard

Name Type Description
displayName
  • string

The dashboard display name

embedUrl
  • string

The dashboard embed url

id
  • string

The dashboard id

isReadOnly
  • boolean

Is ReadOnly dashboard

tiles

The tiles associated with the dashboard

Dashboards

Odata response wrapper for a Power BI dashboard collection

Name Type Description
odata.context
  • string

OData context

value

The dashboard collection

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

Tiles

Odata response wrapper for a Power BI tile collection

Name Type Description
odata.context
  • string

OData context

value

The tile collection