Admin - Dashboards GetDashboardsAsAdmin

Returns a list of dashboards for the organization.

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.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

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

Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports 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

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}

Definitions

AdminDashboard

A Power BI dashboard returned by Admin APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

AdminDashboards

The OData response wrapper for a Power BI dashboard collection

AdminTile

A Power BI tile returned by Admin APIs.

DashboardUser

A Power BI user access right entry for a dashboard

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

PrincipalType

The principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

SubscriptionUser

A Power BI email subscription user

AdminDashboard

A Power BI dashboard returned by Admin APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
appId
  • string

The app ID, returned only if the dashboard belongs to an app

displayName
  • string

The display name of the dashboard

embedUrl
  • string

The embed URL of the dashboard

id
  • string

The dashboard ID

isReadOnly
  • boolean

Whether the dashboard is read-only

subscriptions

(Empty Value) The subscription details for a Power BI item (such as a report or a dashboard). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information for a Power BI report by using the Get Report Subscriptions as Admin API call.

tiles

The tiles that belong to the dashboard

users

(Empty value) The dashboard user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dashboard by using the Get Dashboard Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the dashboard

workspaceId
  • string

The dashboard workspace ID. This property will be returned only in GetDashboardsAsAdmin.

AdminDashboards

The OData response wrapper for a Power BI dashboard collection

Name Type Description
odata.context
  • string

OData context

value

The dashboard 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

DashboardUser

A Power BI user access right entry for a dashboard

Name Type Description
dashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType
  • string

Type of the user.

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

Name Type Description
None
  • string

No permission to content in dashboard

Owner
  • string

Grants Read, Write and Reshare access to content in report

Read
  • string

Grants Read access to content in dashboard

ReadCopy
  • string

Grants Read and Copy access to content in dashboard

ReadReshare
  • string

Grants Read and Reshare access to content in dashboard

ReadWrite
  • string

Grants Read and Write access to content in dashboard

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName
  • string

The service principal profile name

id
  • string

The service principal profile ID

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

Name Type Description
artifactDisplayName
  • string

The name of the subscribed Power BI item (such as a report or a dashboard)

artifactId
  • string

The ID of the subscribed Power BI item (such as a report or a dashboard)

artifactType
  • string

The type of Power BI item (for example a Report, Dashboard, or Dataset)

attachmentFormat
  • string

Format of the report attached in the email subscription

endDate
  • string

The end date and time of the email subscription

frequency
  • string

The frequency of the email subscription

id
  • string

The subscription ID

isEnabled
  • boolean

Whether the email subscription is enabled

linkToContent
  • boolean

Whether a subscription link exists in the email subscription

previewImage
  • boolean

Whether a screenshot of the report exists in the email subscription

startDate
  • string

The start date and time of the email subscription

subArtifactDisplayName
  • string

The page name of the subscribed Power BI item, if it's a report.

title
  • string

The app name

users

The details of each email subscriber. When using the Get User Subscriptions As Admin API call, the returned value is an empty array (null). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information on a Power BI report or dashboard by using the Get Report Subscriptions As Admin or Get Dashboard Subscriptions As Admin API calls.

SubscriptionUser

A Power BI email subscription user

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType
  • string

Type of the user.