Admin - Dashboards GetDashboardsInGroupAsAdmin

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Returns a list of dashboards from the specified workspace.

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/groups/{groupId}/dashboards

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards?$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace ID
$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	AdminDashboards	OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false
    }
  ]
}

Definitions

Name	Description
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	Subscription[]	(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	AdminTile[]	The tiles that belong to the dashboard
users	DashboardUser[]	(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 workspace ID (GUID) of the dashboard. This property will be returned only in GetDashboardsAsAdmin.