Power BI REST APIs

https://learn.microsoft.com/en-nz/rest/api/power-bi/
Admin
The Power BI REST APIs provide service endpoints for embedding, administration, governance, and user...
Tokens:488,382
Snippets:3,354
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Sample Request - Get Datasource

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

Example GET request using a specific gateway ID and data source ID.

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

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

### Sample request with example IDs

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-query-scale-out-sync-status-in-group

Example request using specific group and dataset IDs to get the query scale-out sync status.

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

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

### Get Apps

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

Returns a list of installed apps.

```APIDOC
## Get Apps

### Description
Returns a list of installed apps.

### Method
GET

### Endpoint
/apps

### Response
#### Success Response (200)
- **value** (array) - An array of app objects.

#### Response Example
{
  "value": [
    {
      "id": "app-id",
      "name": "App Name",
      "description": "App description"
    }
  ]
}
```

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

### Get Apps - Sample Request and Response

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

Sample request and response for the Get Apps operation. The response returns a 200 OK status with an Apps object containing a value array of installed apps.

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

```json
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "description": "The finance app",
      "name": "Finance",
      "publishedBy": "Bill",
      "lastUpdate": "2019-01-13T09:46:53.094+02:00"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "description": "The marketing app",
      "name": "Marketing",
      "publishedBy": "Ben",
      "lastUpdate": "2018-11-13T09:46:53.094+02:00"
    }
  ]
}
```

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

### Sample request: Get users of a deployment pipeline

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

Example HTTP request using a specific pipeline ID.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
```

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

### Sample request for Get Datasource Users

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

Example request using a specific gateway ID and datasource ID.

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

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

### Sample Request for Discover Gateways

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

Example GET request using a specific dataset ID (cfafbeb1-8037-4d0c-896e-a46fb27ff229) to discover gateways.

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

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

### Sample Response - Get Datasource

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

Example JSON response for a successful (200 OK) request, returning the GatewayDatasource object.

```JSON
{
  "id": "252b9de8-d915-4788-aaeb-ec8c2395f970",
  "gatewayId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "datasourceType": "Sql",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "credentialType": "Windows",
  "datasourceName": "Sample Datasource"
}
```

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

### Sample Request: Get Tiles In Group

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/dashboards/get-tiles-in-group

Example request with specific group and dashboard IDs. Returns a list of tiles.

```http
GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles
```

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

### Get Groups Examples

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

Examples for the Get Groups API endpoint, including a basic request and a filtered request.

```APIDOC
## [GET] https://api.powerbi.com/v1.0/myorg/groups

### Description
Returns a list of Power BI workspaces (groups) that the user can access. Supports OData query parameters for filtering, skipping, and limiting results.

### Method
GET

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

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Returns a subset of results based on OData filter query parameter condition.
- **$skip** (integer int32) - Optional - Skips the first n results.
- **$top** (integer int32) - Optional - Returns only the first n results.

### Request Example
GET https://api.powerbi.com/v1.0/myorg/groups

### Response
#### Success Response (200)
- **value** (array of Groups) - The list of groups.

#### Response Example
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Large",
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}
```

```APIDOC
## [GET] https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

### Description
Returns a subset of workspaces that match the specified OData filter condition. This example filters groups by name containing 'marketing' or equal to 'contoso'.

### Method
GET

### Endpoint
https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Returns a subset of results based on OData filter query parameter condition.

### Request Example
GET https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

### Response
#### Success Response (200)
- **value** (array of Groups) - The filtered list of groups.

#### Response Example
{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}
```

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

### Sample request - POST admin/workspaces/getInfo with parameters

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/admin/workspace-info-post-workspace-info

Sample HTTP request that sets all optional parameters to True.

```HTTP
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True
```

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

### Create install ticket - Sample Request

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

Sample request body for creating an install ticket with two query parameters. The request includes appId, packageKey, ownerTenantId, and a configuration object.

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

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

### GET /v1.0/myorg/admin/capacities/{capacityId}/refreshables

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

This snippet documents the GET endpoint for retrieving refreshables for a capacity. It includes the base request, a filtered example, and an expanded example.

```APIDOC
## GET /v1.0/myorg/admin/capacities/{capacityId}/refreshables

### Description
Returns a list of refreshables for the specified capacity. This endpoint is used by administrators to monitor refresh operations.

### Method
GET

### Endpoint
https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables

### Parameters
#### Path Parameters
- **capacityId** (string) - Required - The capacity identifier.

#### Query Parameters
- **$filter** (string) - Optional - An OData filter expression to filter the results. For example, `averageDuration gt 1800` filters for refreshables with an average refresh duration greater than 30 minutes.
- **$expand** (string) - Optional - A comma-separated list of navigation properties to expand. For example, `capacity,group` expands the capacity and group properties.

### Request Example
```
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables
```

### Response
#### Success Response (200)
- **value** (array) - A list of refreshable objects.
  - **id** (string) - The refreshable identifier.
  - **name** (string) - The refreshable name.
  - **kind** (string) - The type of refreshable (e.g., Dataset).
  - **startTime** (string) - The start time of the refresh.
  - **endTime** (string) - The end time of the refresh.
  - **refreshCount** (integer) - The number of refreshes.
  - **refreshFailures** (integer) - The number of refresh failures.
  - **averageDuration** (number) - The average refresh duration in seconds.
  - **medianDuration** (number) - The median refresh duration in seconds.
  - **refreshesPerDay** (integer) - The number of refreshes per day.
  - **lastRefresh** (object) - Information about the last refresh.
    - **refreshType** (string) - The type of refresh (e.g., ViaApi).
    - **startTime** (string) - The start time of the last refresh.
    - **endTime** (string) - The end time of the last refresh.
    - **status** (string) - The status of the last refresh (e.g., Completed).
    - **requestId** (string) - The request identifier.
  - **refreshSchedule** (object) - The refresh schedule.
    - **days** (array) - The days of the week when refresh occurs.
    - **times** (array) - The times of day when refresh occurs.
    - **enabled** (boolean) - Whether the schedule is enabled.
    - **localTimeZoneId** (string) - The local time zone identifier.
    - **notifyOption** (string) - The notification option (e.g., MailOnFailure).
  - **configuredBy** (array) - The users who configured the refreshable.
  - **capacity** (object) - The capacity information (when expanded).
    - **id** (string) - The capacity identifier.
    - **displayName** (string) - The capacity display name.
    - **sku** (string) - The capacity SKU.
  - **group** (object) - The group information (when expanded).
    - **id** (string) - The group identifier.
    - **name** (string) - The group name.

#### Response Example
```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 Report - Sample Response

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

Example response with status code 200 for the Get Report operation.

```json
{
  "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"
}
```

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

### Create install ticket - Sample Response 200

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

Successful response (200 OK) containing the install ticket, ticket ID, and expiration date.

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

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

### Create Workspace Example - Sample Response

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

Sample JSON response for a successful workspace creation, returning the workspace ID, read-only flag, dedicated capacity flag, and name.

```JSON
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isOnDedicatedCapacity": false,
      "name": "sample workspace"
    }
  ]
}
```

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

### Get Report - Sample Request

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

Example request for the Get Report operation using a specific report ID.

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

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

### Create install ticket - Sample Response 400

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

Error response (400) when the install ticket configuration is invalid.

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

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

### GET /v1.0/myorg/admin/dataflows

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

This snippet documents the GET /v1.0/myorg/admin/dataflows endpoint, including its query parameters, request example, and response structure.

```APIDOC
## GET /v1.0/myorg/admin/dataflows

### Description
Returns a list of dataflows for the organization. This is an admin API that requires appropriate permissions.

### Method
GET

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

### Parameters
#### Query Parameters
- **$filter** (string) - Optional - Returns a subset of results based on OData filter query parameter condition.
- **$skip** (integer int32) - Optional - Skips the first n results.
- **$top** (integer int32) - Optional - Returns only the first n results.

### Request Example
```
GET https://api.powerbi.com/v1.0/myorg/admin/dataflows
```

### Response
#### Success Response (200)
- **value** (AdminDataflow[]) - The dataflow collection.

#### Response Example
```json
{
  "value": [
    {
      "objectId": "bd32e5c0-363f-430b-a03b-5535a4804b9b",
      "name": "AdventureWorks",
      "description": "Our Adventure Works",
      "modelUrl": "https://MyDataflowStorageAccount.dfs.core.windows.net/powerbi/contoso/AdventureWorks/model.json",
      "configuredBy": "john@contoso.com",
      "workspaceId": "6369a442-4bc4-425c-916d-460c42be746b"
    }
  ]
}
```
```

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

### Create Workspace Example - Sample Request

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

Sample HTTP request to create a workspace with the workspaceV2 parameter set to True. The request body includes the workspace name.

```HTTP
POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2=True
```

```JSON
{
  "name": "sample workspace"
}
```

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

### Get App

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

Returns the specified installed app.

```APIDOC
## Get App

### Description
Returns the specified installed app.

### Method
GET

### Endpoint
/apps/{appId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - The app ID.

### Response
#### Success Response (200)
- **id** (string) - The app ID.
- **name** (string) - The app name.
- **description** (string) - The app description.

#### Response Example
{
  "id": "app-id",
  "name": "App Name",
  "description": "App description"
}
```

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

### SQL Example - Request

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

Sample request for creating a SQL data source. The request body includes dataSourceType, connectionDetails, datasourceName, and credentialDetails with Windows credentials.

```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 deployment pipelines example - JSON response

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

Sample JSON response with status code 200, containing a list of deployment pipelines with id, displayName, and description.

```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"
    }
  ]
}
```

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

### Sample Request - Get Refresh Schedule In Group

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-refresh-schedule-in-group

Sample request for the Get Refresh Schedule In Group API. Uses example group and dataset IDs.

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

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

### Get all deployment pipelines

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

Returns a list of deployment pipelines for the organization. Requires administrator rights or a service principal, and the Tenant.Read.All or Tenant.ReadWrite.All scope. Limited to 200 requests per hour.

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

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

### GET /admin/pipelines

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

This snippet documents the GET /admin/pipelines endpoint, including its query parameters and response structure, with examples for expanding stages or users and filtering orphaned pipelines.

```APIDOC
## [GET] /admin/pipelines

### Description
Gets a list of deployment pipelines as an admin.

### Method
GET

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

### Parameters
#### Query Parameters
- **$expand** (string) - Optional - A comma-separated list of related entities to expand. Supported values: `stages`, `users`.
- **$filter** (string) - Optional - A filter expression to filter the results. For example, `(not users/any())` to get orphaned pipelines.
- **$top** (integer) - Optional - The maximum number of pipelines to return.

### Response
#### Success Response (200)
- **value** (array of AdminPipelines) - The list of deployment pipelines.

#### Response Example
```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 datasources in group - SQL example

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-datasources-in-group

Sample request and response for getting datasources of a dataset in a group, with a SQL datasource. The response includes datasourceType, connectionDetails, datasourceId, and gatewayId.

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

```JSON
{
  "value": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "My-As-Server",
        "database": "My-As-Database"
      },
      "datasourceId": "33cc5222-3fb9-44f7-b19d-ffbff18aaaf5",
      "gatewayId": "0a2dafe6-0e93-4120-8d2c-fae123c111b1"
    }
  ]
}
```

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

### Get Dashboards as Admin - Sample Response

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

Example response for the Get Dashboards as Admin request. Shows a dashboard object with id, displayName, embedUrl, isReadOnly, and workspaceId properties.

```json
{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}
```

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

### POST admin/workspaces/getInfo - With optional parameters

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/admin/workspace-info-post-workspace-info

Initiates a metadata scan with optional parameters: lineage, datasourceDetails, datasetSchema, datasetExpressions, and getArtifactUsers. Setting datasetSchema or datasetExpressions to true requires fully enabling metadata scanning.

```HTTP
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}
```

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

### Get datasources in group - SharePoint example

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-datasources-in-group

Sample request and response for getting datasources of a dataset in a group, with a SharePoint list datasource. The response includes datasourceType, connectionDetails, datasourceId, and gatewayId.

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

```JSON
{
  "value": [
    {
      "datasourceType": "SharePointList",
      "connectionDetails": {
        "url": "https://microsoft.sharepoint.com/hello/myproj/"
      },
      "datasourceId": "33cc5222-3fb9-44f7-b19d-ffbff18aaaf5",
      "gatewayId": "0a2dafe6-0e93-4120-8d2c-fae123c111b1"
    }
  ]
}
```

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

### Sample request: GET group by ID

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

Example request using a specific groupId (f089354e-8366-4e18-aea3-4cb4a3a50b48).

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

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

### Create Group Example - Sample Response

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

Sample JSON response for a successful group creation, returning the group ID, read-only flag, dedicated capacity flag, and name.

```JSON
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    }
  ]
}
```

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

### POST CreateTemplateAppInstallTicket

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

This snippet documents the CreateTemplateAppInstallTicket endpoint, including its request body, response, and error examples.

```APIDOC
## [POST] CreateTemplateAppInstallTicket

### Description
Generates an installation ticket for the automated install flow of the specified template app. The caller must use service principal for authentication.

### 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 Response (401)
{
  "error": {
    "code": "ServiceAppApplicationOwnershipValidationFailed",
    "pbi.error": {
      "code": "ServiceAppApplicationOwnershipValidationFailed",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

#### Error Response (400)
{
  "error": {
    "code": "ServiceAppInstallTicketInvalidConfiguration",
    "pbi.error": {
      "code": "ServiceAppInstallTicketInvalidConfiguration",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}

```

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

### Completed refresh example - sample request (HTTP GET)

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-refresh-history

Sample HTTP GET request to retrieve the refresh history for a dataset, using the $top query parameter to limit to 1 entry.

```HTTP
GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1
```

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

### Get datasources in group - SAP HANA example

Source: https://learn.microsoft.com/en-nz/rest/api/power-bi/datasets/get-datasources-in-group

Sample request and response for getting datasources of a dataset in a group, with a SAP HANA datasource. The response includes datasourceType, connectionDetails, datasourceId, and gatewayId.

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

```JSON
{
  "value": [
    {
      "datasourceType": "SAPHana",
      "connectionDetails": {
        "server": "My-SapHana-Server",
        "database": "My-SapHana-Database"
      },
      "datasourceId": "33cc5222-3fb9-44f7-b19d-ffbff18aaaf5",
      "gatewayId": "0a2dafe6-0e93-4120-8d2c-fae123c111b1"
    }
  ]
}
```

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

### Sample request for Get Datasets in Group

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

Sends a GET request to the Power BI REST API to retrieve datasets in a group. The group ID is specified in the URL path. This is the standard example.

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

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

### Sample response: Get users of a deployment pipeline

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

Example JSON response with status code 200, containing a list of users with access rights and principal types.

```JSON
{
  "value": [
    {
      "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"
    }
  ]
}
```
Tokens:
Raw