Admin - Reports GetReportsAsAdmin

Returns a list of reports for the organization.

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/reports
GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
$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

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/reports

Sample Response

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

Definitions

EndorsementDetails

Power BI endorsement details

PrincipalType

The principal type

Report

A Power BI report. 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.

Reports

The OData response wrapper for a Power BI report collection

ReportUser

A Power BI user access right entry for report

ReportUserAccessRight

Access rights user has for the report (Permission level)

SensitivityLabel

Artifact sensitivity label info

Subscription

artifact email subscription

SubscriptionUser

A Power BI email subscription user

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact

endorsement
  • string

The endorsement status

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

Report

A Power BI report. 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
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

endorsementDetails

The report endorsement details

id
  • string

The report ID

modifiedBy
  • string

The user that modified the report

modifiedDateTime
  • string

The report modified date and time

name
  • string

The name of the report

reportType enum:
  • PaginatedReport

The report type

sensitivityLabel

The report sensitivity label

subscriptions

(Empty Value)The Report subscription Details. It will be removed from the payload response in an upcoming release. To retrieve subscription information for report, please consider using the Get Report Subscriptions as Admin API.

users

(Empty value) The report 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 item (such as a report or a dashboard) by using the Get Report Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the report

Reports

The OData response wrapper for a Power BI report collection

Name Type Description
odata.context
  • string

OData context

value

The report collection

ReportUser

A Power BI user access right entry for 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

The principal type

reportUserAccessRight

Access rights user has for the report (Permission level)

ReportUserAccessRight

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

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID

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.

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