Dashboards - Get Dashboards In Group

Returns a list of dashboards from the specified workspace.

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

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace ID

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards

Sample Response

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "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

DashboardUser

A Power BI user access right entry for dashboard

DashboardUserAccessRight

Access rights user has for the dashboard (Permission level)

PrincipalType

The principal type

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.

users

The Dashboard User Access Details. This value will be empty. It will be removed from the payload response in an upcoming release. To retrieve user information on an artifact, please consider using the Get Dashboard User as Admin APIs, or the PostWorkspaceInfo API with the getArtifactUser parameter.

Dashboards

Odata response wrapper for a Power BI dashboard collection

Name Type Description
odata.context
  • string

OData context

value

The dashboard collection

DashboardUser

A Power BI user access right entry for dashboard

Name Type Description
dashboardUserAccessRight

Access rights 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

DashboardUserAccessRight

Access rights 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

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

None principal type, used for whole organization level access.

User
  • string

User principal type

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, which is available only for tiles created from a report or using a dataset, such as 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, which is available only for tiles created from a report

rowSpan
  • integer

number of rows a tile should span

title
  • string

The dashboard display name