Reports - Get Pages In Group

Service:

Power BI REST APIs

API Version:

v1.0

Returns a list of pages within the specified report from the specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Report.ReadWrite.All or Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/pages

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace ID
reportId	path	True	string uuid	The report ID

Responses

Name	Type	Description
200 OK	Pages	OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/879445d6-3a9e-4a74-b5ae-7c0ddabf0f11/pages

Sample Response

Status code:

200

{
  "value": [
    {
      "displayName": "Regional Sales Analysis",
      "name": "ReportSection",
      "order": "0"
    },
    {
      "displayName": "Geographic Analysis",
      "name": "ReportSection1",
      "order": "1"
    }
  ]
}

Definitions

Page	A Power BI report page
Pages	The OData response wrapper for a Power BI page collection

Page

A Power BI report page

Name	Type	Description
displayName	string	The display name of the report page
name	string	The name of the report page
order	integer	The order of the report page

Pages

The OData response wrapper for a Power BI page collection

Name	Type	Description
odata.context	string	OData context
value	Page[]	The page collection