Admin - Dashboards GetDashboardSubscriptionsAsAdmin

Returns a list of subscriptions along with subscribees that the dashboard subscribed to. This is a preview API call.

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/{dashboardId}/subscriptions

URI Parameters

Name In Required Type Description
dashboardId
path True
  • string
uuid

The dashboard ID

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/subscriptions

Sample Response

{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424275",
      "title": "TestDashboardSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "artifactType": "Dashboard",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": false,
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

Definitions

PrincipalType

The principal type

Subscription

artifact email subscription

Subscriptions

OData response wrapper for a Power BI subscriptions

SubscriptionUser

A Power BI email subscription user

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

Subscription

artifact email subscription

Name Type Description
artifactDisplayName
  • string

The subscribed artifact Name

artifactId
  • string

The subscribed artifact ID

artifactType
  • string

artifactType

attachmentFormat
  • string

Format of the report attached in the eamil subscription

endDate
  • string

The start date and time of subscription

frequency
  • string

Frequency of Email Subscription

id
  • string

The subscription ID

isEnabled
  • boolean

subscription Enabled or not

linkToContent
  • boolean

subscription link exists in email subscription

previewImage
  • boolean

screenshot of the report exists in email subscription

startDate
  • string

The start date and time of subscription

subArtifactDisplayName
  • string

Page Name in case of Reports only

title
  • string

The app name

users

The Email subscribee Details. This value can be null when Get Subscirpions By User As Admin API is called. It will be removed from the payload response in an upcoming release. To retrieve subscription information on an artifact please consider using the Get Dashboard or Report Subscriptions as Admin API.

Subscriptions

OData response wrapper for a Power BI subscriptions

Name Type Description
odata.context
  • string
value

powerBI email subscription

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