Admin - Reports GetReportsInGroupAsAdmin

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Returns a list of reports from the specified workspace.

Permissions

  • The user must be a Fabric 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}/reports
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports?$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
groupId
 path True

string

uuid

The workspace ID
$filter
 query

string

Returns a subset of a results based on Odata filter query parameter 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

AdminReports

OK

Examples

Example

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Definitions

Name Description
AdminReport

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

OData response wrapper for a Power BI Admin report collection
PrincipalType

The principal type
ReportUser

A Power BI user access right entry for a report
ReportUserAccessRight

The access right that the user has for the report (permission level)
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

AdminReport

A Power BI report returned by Admin APIs. The API returns a subset of the following list of report 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 report belongs to an app
createdBy

string

The report owner. Available only for reports created after June 2019.
createdDateTime

string

The report creation date and time
datasetId

string

The dataset ID of the report
description

string

The report description
embedUrl

string

The embed URL of the report
id

string

The report ID
isOwnedByMe

boolean

Determine if the report is created by the current user.
modifiedBy

string

The last user that modified the report
modifiedDateTime

string

The date and time that the report was last modified
name

string

The name of the report
originalReportId

string

The actual report ID when the workspace is published as an app.
reportType enum:
  • PaginatedReport
  • PowerBIReport

The report type
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.
users

ReportUser[]

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

string

The web URL of the report
workspaceId

string

The workspace ID (GUID) of the report. This property will be returned only in GetReportsAsAdmin.

AdminReports

OData response wrapper for a Power BI Admin report collection

Name Type Description
odata.context

string

OData context
value

AdminReport[]

The report collection

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

ReportUser

A Power BI user access right entry for a report

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.
reportUserAccessRight

ReportUserAccessRight

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

string

Type of the user.

ReportUserAccessRight

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

Name Type Description
None

string

No permission to content in report
Owner

string

Grants Read, Write and Reshare access to content in report
Read

string

Grants Read access to content in report
ReadCopy

string

Grants Read and Copy access to content in report
ReadReshare

string

Grants Read and Reshare access to content in report
ReadWrite

string

Grants Read and Write access to content in report

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.

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.