Admin - Reports GetReportSubscriptionsAsAdmin

Returns a list of report subscriptions along with subscriber details. This is a preview API call.

Permissions

  • The user must be a Fabric 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/reports/{reportId}/subscriptions

URI Parameters

Name In Required Type Description
reportId
path True

string

uuid

The report ID

Responses

Name Type Description
200 OK

Subscriptions

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Sample response

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

Definitions

Name Description
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)

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

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

SubscriptionUser[]

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.

Subscriptions

OData response wrapper for a Power BI subscriptions

Name Type Description
odata.context

string

value

Subscription[]

Power BI 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

PrincipalType

The principal type

profile

ServicePrincipalProfile

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

userType

string

Type of the user.