Power BI REST API

https://learn.microsoft.com/en-us/rest/api/power-bi/
Admin
Power BI REST API provides service endpoints for managing Power BI content, performing...
Tokens:464,298
Snippets:3,381
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Sample Get Tile Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-tile

An example of a GET request for a specific app ID.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards/{dashboardId}/tiles/{tileId}
```

--------------------------------

### Sample Get Tile Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/dashboards/get-tile

An example of a concrete GET request to retrieve a specific tile.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b
```

--------------------------------

### Get deployment pipelines example

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipelines-as-admin

Sample request to get all deployment pipelines as an admin. The response returns a list of pipelines with their id, displayName, and description.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
```

```JSON
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports"
    }
  ]
}
```

--------------------------------

### Get Workloads Example Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workloads

A sample HTTP GET request targeting a specific capacity ID.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/capacities/0f084df7-c13d-451b-af5f-ed0c466403b2/Workloads
```

--------------------------------

### Sample Request - Get Datasource

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasource

Sample request for the Get Datasource operation using example gateway and datasource IDs.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970
```

--------------------------------

### Sample request for Get Report

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-report

Example GET request using a specific appId. The reportId is still a placeholder.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/reports/{reportId}
```

--------------------------------

### Sample request - Get dashboards from an app

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboards

Example request with a specific appId. This is the sample request for the Get Dashboards operation.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards
```

--------------------------------

### Sample request for Get Workload

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workload

Example GET request using a specific capacity ID and workload name (Dataflows).

```HTTP
GET https://api.powerbi.com/v1.0/myorg/capacities/0f084df7-c13d-451b-af5f-ed0c466403b2/Workloads/Dataflows
```

--------------------------------

### Get deployment pipelines with their 'users' expanded example

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipelines-as-admin

Sample request to get deployment pipelines with their users expanded. The response includes a users array with identifier, accessRight, and principalType for each user.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$top=100
```

```JSON
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "users": [
        {
          "identifier": "john@contoso.com",
          "accessRight": "Admin",
          "principalType": "User"
        },
        {
          "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
          "accessRight": "Admin",
          "principalType": "Group"
        },
        {
          "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
          "accessRight": "Admin",
          "principalType": "App"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}
```

--------------------------------

### Get orphaned deployment pipelines example

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipelines-as-admin

Sample request to get orphaned deployment pipelines, which are pipelines with no users. The response returns only pipelines with an empty users array.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$filter=(not users/any())&$top=100
```

```JSON
{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}
```

--------------------------------

### Sample Request Body: Create Install Ticket with Two Query Parameters

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticket

JSON request body for creating an install ticket, specifying appId, packageKey, ownerTenantId, and configuration parameters.

```json
{
  "appId": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "packageKey": "g632bb64...OfsoqT56xEM=",
  "ownerTenantId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
  "config": {
    "configuration": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}
```

--------------------------------

### Sample Response 200: Install Ticket

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticket

Successful response with ticket, ticketId, and expiration.

```json
{
  "ticket": "H4sI....AAA=",
  "ticketId": "4b76f5ed-5a06-4150-8d1b-60f8e4c186f4",
  "expiration": "2020-07-29T17:58:19Z"
}
```

--------------------------------

### Get Apps Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-apps

The HTTP GET request to retrieve the list of installed apps for the organization.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/apps
```

--------------------------------

### Sample response for deployAll operation

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/deploy-all

Example JSON response with status 200, containing a deployment operation object with status 'NotStarted' and stage order details.

```json
{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}
```

--------------------------------

### Sample request: GET datasets with $expand=encryption

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasets-in-group-as-admin

HTTP GET request that includes the $expand query parameter set to 'encryption' to expand related encryption information inline. This is the example titled 'Example with expand on encryption'.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?$expand=encryption
```

--------------------------------

### Sample response with data source details

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasources-as-admin

Example JSON response showing a data source with connection string, type, ID, gateway ID, and connection details.

```JSON
{
  "value": [
    {
      "name": "301",
      "connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False",
      "datasourceType": "Sql",
      "datasourceId": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
      "gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
      "connectionDetails": {
        "server": "MyServer.database.windows.net",
        "database": "MyDatabase"
      }
    }
  ]
}
```

--------------------------------

### Sample Request for Get Report

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-report

Example GET request using a specific report ID (5b218778-e7a5-4d73-8187-f10824047715).

```HTTP
GET https://api.powerbi.com/v1.0/myorg/reports/5b218778-e7a5-4d73-8187-f10824047715
```

--------------------------------

### Get Pages - Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-pages

Example HTTP GET request using a specific report ID.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/reports/879445d6-3a9e-4a74-b5ae-7c0ddabf0f11/pages
```

--------------------------------

### Sample request for admin apps

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/apps-get-apps-as-admin

Example request that retrieves the first 10 apps in the organization.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/apps?$top=10
```

--------------------------------

### Sample response for Get Report

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/apps/get-report

Example 200 OK response containing the report details such as appId, datasetId, id, name, webUrl, and embedUrl.

```JSON
{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "66b2570c-d9d3-40b2-83d9-1095c6700041",
  "name": "SalesMarketing",
  "webUrl": "https://app.powerbi.com/reports/66b2570c-d9d3-40b2-83d9-1095c6700041",
  "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=66b2570c-d9d3-40b2-83d9-1095c6700041&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ"
}
```

--------------------------------

### Get Group - Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/groups/get-group

Example HTTP GET request using a specific group ID.

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

--------------------------------

### Sample Discover Gateways Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/discover-gateways-in-group

An example of the GET request using specific workspace and dataset IDs.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.DiscoverGateways
```

--------------------------------

### Sample request and response for get refreshable

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/get-refreshable-for-capacity

Example request and 200 OK response showing refreshable details without expansion.

```http
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}
```

```json
{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}
```

--------------------------------

### Get Group Users as Admin - Sample Request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-group-users-as-admin

Example request to get users for a workspace with ID f089354e-8366-4e18-aea3-4cb4a3a50b48.

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

--------------------------------

### Sample response (200 OK)

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-dataset

Example JSON response for a successful get dataset operation.

```json
{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "addRowsAPIEnabled": false,
  "configuredBy": "john@contoso.com",
  "isRefreshable": true,
  "isEffectiveIdentityRequired": true,
  "isEffectiveIdentityRolesRequired": true,
  "isOnPremGatewayRequired": false
}
```

--------------------------------

### GET /LinkedReports({Id})/HistorySnapshotOptions

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/linked-reports/get-linked-report-history-snapshot-options

Gets HistorySnapshotOptions for the specified LinkedReport. The Id parameter is required and can be a GUID or a path.

```APIDOC
## GET /LinkedReports({Id})/HistorySnapshotOptions

### Description
Gets HistorySnapshotOptions for the specified LinkedReport.

### Method
GET

### Endpoint
/LinkedReports({Id})/HistorySnapshotOptions

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **History Snapshot Options** - The response contains the history snapshot options.

#### Error Response
Other Status Codes - Error

```

--------------------------------

### Sample request and response for Get Parameters

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-parameters

Example request using a specific dataset ID and the corresponding 200 OK response with a MashupParameters object containing parameter details.

```http
GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/parameters
```

```json
{
  "value": [
    {
      "name": "ServerName",
      "type": "Text",
      "isRequired": true,
      "currentValue": "MyTest.database.windows.net"
    },
    {
      "name": "DatabaseName",
      "type": "Text",
      "isRequired": true,
      "currentValue": "MyTestDB"
    },
    {
      "name": "FromDate",
      "type": "DateTime",
      "isRequired": true,
      "currentValue": "2/8/2002 12:00:00 AM"
    },
    {
      "name": "FilterBlanks",
      "type": "Logical",
      "isRequired": true,
      "currentValue": "TRUE"
    },
    {
      "name": "MaxId",
      "type": "Number",
      "isRequired": true,
      "currentValue": "77"
    },
    {
      "name": "AnyParam",
      "type": "Any",
      "isRequired": true,
      "currentValue": "uu63"
    }
  ]
}
```

--------------------------------

### Get Group - Sample Response

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/groups/get-group

Example JSON response for a successful Get Group request (status code 200).

```json
{
  "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "isReadOnly": false,
  "isOnDedicatedCapacity": true,
  "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
  "defaultDatasetStorageFormat": "Small",
  "name": "Sample Group 1"
}
```

--------------------------------

### Get Workloads Example Response

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/capacities/get-workloads

A sample JSON response showing the state and memory percentage for capacity workloads.

```JSON
{
  "value": [
    {
      "state": "Enabled",
      "name": "Dataflows",
      "maxMemoryPercentageSetByUser": "66"
    },
    {
      "state": "Disabled",
      "name": "PaginatedReports"
    }
  ]
}
```

--------------------------------

### SQL example - request

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/create-datasource

Sample request for creating a SQL datasource. The connectionDetails is a JSON string with server and database. The credentialDetails uses Windows credentials with encrypted connection.

```http
POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources
```

```json
{
  "dataSourceType": "SQL",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "datasourceName": "Sample Datasource",
  "credentialDetails": {
    "credentialType": "Windows",
    "credentials": "AB....EF==",
    "encryptedConnection": "Encrypted",
    "encryptionAlgorithm": "RSA-OAEP",
    "privacyLevel": "None"
  }
}
```

--------------------------------

### GET /Reports({Id})/HistorySnapshots

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/reports/get-report-history-snapshots

Get a list of HistorySnapshots for the specified Report. The report is identified by its Id, which can be a GUID or a path.

```APIDOC
## GET /Reports({Id})/HistorySnapshots

### Description
Get a list of HistorySnapshots for the specified Report.

### Method
GET

### Endpoint
/Reports({Id})/HistorySnapshots

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200 OK)
- **Ok** - The request was successful.

#### Error Response (Other Status Codes)
- **Error** - An error occurred.

```

--------------------------------

### Sample Response 400: ServiceAppInstallTicketInvalidConfiguration

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticket

Error response when the install ticket configuration is invalid.

```json
{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}
```

--------------------------------

### GET /Resources({Id})/Policies

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/resources/get-resource-policies

Gets ItemPolicies on the Resource item. The resource is identified by its unique key (GUID or path).

```APIDOC
## GET /Resources({Id})/Policies

### Description
Gets ItemPolicies on the Resource item.

### Method
GET

### Endpoint
/Resources({Id})/Policies

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **200 OK** - Ok

#### Error Response
- **Other Status Codes** - Error

```

--------------------------------

### Sample Request: POST Default.SetAllConnections

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/set-all-dataset-connections-in-group

Example request with a specific group ID and dataset ID. The request body contains a connection string.

```HTTP
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.SetAllConnections
```

```JSON
{
  "connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False"
}
```

--------------------------------

### POST /v1.0/myorg/CreateTemplateAppInstallTicket

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/template-apps/create-install-ticket

Documentation for the CreateTemplateAppInstallTicket endpoint, including request body, response, and definitions.

```APIDOC
## POST /v1.0/myorg/CreateTemplateAppInstallTicket

### Description
Generates an installation ticket for the automated install flow of the specified template app.

### Method
POST

### Endpoint
https://api.powerbi.com/v1.0/myorg/CreateTemplateAppInstallTicket

### Parameters
#### Request Body
- **installDetails** (TemplateAppInstallDetails[]) - Required - List of install details

### Request Example
{
  "appId": "91ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
  "packageKey": "g632bb64...OfsoqT56xEM=",
  "ownerTenantId": "d43e3248-3d83-44aa-a94d-c836bd7f9b79",
  "config": {
    "configuration": {
      "param1": "value1",
      "param2": "value2"
    }
  }
}

### Response
#### Success Response (200)
- **ticket** (string) - Install ticket
- **ticketId** (string (uuid)) - The unique ID of an install ticket. Audit logs can be used to correlate operations that use this ticket with the generate ticket operation.
- **expiration** (string (date-time)) - The expiration date and time (UTC) of the ticket

#### Response Example
{
  "ticket": "H4sI....AAA=",
  "ticketId": "4b76f5ed-5a06-4150-8d1b-60f8e4c186f4",
  "expiration": "2020-07-29T17:58:19Z"
}

#### Error Responses
##### 400 Bad Request
{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

##### 401 Unauthorized
{
  "error": {
    "code": "ServiceAppApplicationOwnershipValidationFailed",
    "pbi.error": {
      "code": "ServiceAppApplicationOwnershipValidationFailed",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

### Definitions
#### CreateInstallTicketRequest
A request to create a Power BI install ticket
- **installDetails** (TemplateAppInstallDetails[]) - List of install details

#### InstallTicket
An automated install ticket for a Power BI template app
- **expiration** (string (date-time)) - The expiration date and time (UTC) of the ticket
- **ticket** (string) - Install ticket
- **ticketId** (string (uuid)) - The unique ID of an install ticket. Audit logs can be used to correlate operations that use this ticket with the generate ticket operation.

#### TemplateAppConfigurationRequest
An automated install configuration for a Power BI template app (dictionary of name-value pairs)
- **configuration** (object) - 

#### TemplateAppInstallDetails
The install details for a Power BI template app
- **appId** (string (uuid)) - The unique ID of the Power BI template app
- **config** (TemplateAppConfigurationRequest) - The automated install configuration
- **ownerTenantId** (string (uuid)) - The tenant ID of the Power BI template app owner
- **packageKey** (string) - The secure key for the Power BI template app version
```

--------------------------------

### GET /Reports({Id})/Policies

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/reports/get-report-policies

Gets policies associated with the specified Report CatalogItem. The Id parameter is required and can be a GUID or a path.

```APIDOC
## GET /Reports({Id})/Policies

### Description
Gets policies associated with the specified Report CatalogItem.

### Method
GET

### Endpoint
/Reports({Id})/Policies

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **200 OK** - Ok

#### Error Response
- **Other Status Codes** - Error

```

--------------------------------

### Get deployment pipelines with their 'stages' expanded example

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipelines-as-admin

Sample request to get deployment pipelines with their stages expanded. The response includes a stages array with order, workspaceId, and workspaceName for each stage.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=stages&$top=100
```

```JSON
{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "stages": [
        {
          "order": "0",
          "workspaceId": "5dba60b0-d9a7-42a3-b12c-6d9d51e7739a",
          "workspaceName": "SQlAzure-Refresh"
        },
        {
          "order": "1",
          "workspaceId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "workspaceName": "SQlAzure-Refresh[Test]"
        },
        {
          "order": "2"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /Reports({Id})/SharedDataSets

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/reports/get-report-shared-data-sets

Gets the shared DataSets for the specified Report. The report is identified by its unique key (GUID or path).

```APIDOC
## GET /Reports({Id})/SharedDataSets

### Description
Gets the shared DataSets for the specified Report.

### Method
GET

### Endpoint
/Reports({Id})/SharedDataSets

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **200 OK** - Ok

#### Error Response
- **Other Status Codes** - Error

```

--------------------------------

### GET /PowerBIReports({Id})/Content/$value

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/power-bi-reports/get-power-bi-report-content

Gets the content of the specified PowerBIReport CatalogItem. The Id parameter is required and can be a GUID or a path.

```APIDOC
## GET /PowerBIReports({Id})/Content/$value

### Description
Gets the content of the specified PowerBIReport CatalogItem.

### Method
GET

### Endpoint
/PowerBIReports({Id})/Content/$value

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **Content** - The content of the report.

#### Response Example
(No explicit response example provided)

#### Error Responses
- **404 Not Found** - Not found.
- **Other Status Codes** - Error
```

--------------------------------

### GET /MobileReports({Id})/Content/$value

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/mobile-reports/get-mobile-report-content

Gets the content of the specified MobileReport CatalogItem. The Id parameter is required and can be a GUID or a path.

```APIDOC
## GET /MobileReports({Id})/Content/$value

### Description
Gets the content of the specified MobileReport CatalogItem.

### Method
GET

### Endpoint
/MobileReports({Id})/Content/$value

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- The content of the specified MobileReport CatalogItem.

#### Response Example
(No response example provided)

#### Error Responses
- **404 Not Found** - Not found.
- **Other Status Codes** - Error
```

--------------------------------

### Get Pipeline with Stages Expanded - Sample Request and Response

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline

Example request and 200 OK response for retrieving a deployment pipeline with its 'stages' expanded. The response includes the pipeline ID, display name, description, and an array of stages with order, workspaceId, and workspaceName.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages
```

```JSON
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline",
  "description": "My deployment pipeline",
  "stages": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}
```

--------------------------------

### GET /MobileReports({Id})/Policies

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/mobile-reports/get-mobile-report-policies

Gets the ItemPolicies associated with the MobileReport catalog item. The Id parameter is required and can be a GUID or a path.

```APIDOC
## GET /MobileReports({Id})/Policies

### Description
Gets ItemPolicies associated with the MobileReport catalog item.

### Method
GET

### Endpoint
/MobileReports({Id})/Policies

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
- **200 OK** - Ok

#### Other Status Codes
- **Other Status Codes** - Error

```

--------------------------------

### Sample response: 200 OK with stage artifacts

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline-stage-artifacts

Example response for a successful request. It lists the artifacts in the stage, including dataflows, datamarts, datasets, reports, and dashboards, with their IDs and deployment times.

```json
{
  "dataflows": [
    {
      "artifactId": "527700ab-3cdb-4637-8402-912a129b2a92",
      "artifactDisplayName": "Sales Dataflow",
      "sourceArtifactId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    }
  ],
  "datamarts": [
    {
      "artifactId": "a7654a17-c5d1-4539-b9ec-022075545e50",
      "artifactDisplayName": "Sales Datamart",
      "sourceArtifactId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "lastDeploymentTime": "2021-06-06T11:55:59.057Z"
    }
  ],
  "datasets": [
    {
      "artifactId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
      "artifactName": "Sales Dataset",
      "sourceArtifactId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
      "targetArtifactId": "a5cf347e-7b49-4198-8a2b-0aa92c37d8f8",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    }
  ],
  "reports": [
    {
      "artifactId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
      "artifactName": "Sales Report",
      "sourceArtifactId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "lastDeploymentTime": "2020-12-13T09:26:41.153Z"
    }
  ],
  "dashboards": [
    {
      "artifactId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
      "artifactName": "Sales Dashboard"
    }
  ]
}
```

--------------------------------

### GET /Folders({Id})

Source: https://learn.microsoft.com/en-us/rest/api/power-bi-report/folders/get-folder

Gets a Folder CatalogItem specified by the Id. The Id is a key (GUID or path) that uniquely identifies the object.

```APIDOC
## GET /Folders({Id})

### Description
Gets a Folder CatalogItem specified by the Id.

### Method
GET

### Endpoint
/Folders({Id})

### Parameters
#### Path Parameters
- **Id** (string) - Required - The key (GUID or path) that uniquely identifies the object. GUID example: 01234567-89ab-cdef-0123-456789abcdef path example: path='/folder1/folder2/item' If the path itself contains single quote, it should be escaped - add another single quote.

### Response
#### Success Response (200)
The Folder CatalogItem specified by the Id.

#### Error Responses
- **400 Bad Request** - Couldn't understand your request.
- **404 Not Found** - Not found.
- **Other Status Codes** - Error
```

--------------------------------

### Sample Request - Get Pages In Group

Source: https://learn.microsoft.com/en-us/rest/api/power-bi/reports/get-pages-in-group

Sample request for the Get Pages In Group API. Uses example groupId and reportId values.

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