Reports - Get Reports

Returns a list of reports from My workspace.

This API also returns shared reports and reports from shared apps. Reports that reside in shared workspaces can be accessed using the Get Reports In Group API.

Since paginated reports (RDL) don't have a dataset, the dataset ID value in the API response for paginated reports isn't displayed.

Required Scope

Report.ReadWrite.All or Report.Read.All

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

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/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

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

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
appId
  • string

The app ID, returned only if the report belongs to an app

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

name
  • string

The name of the report

reportType enum:
  • PaginatedReport

The report type

subscriptions

(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

(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

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

The principal type

profile

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

reportUserAccessRight

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

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

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

The principal type

profile

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