Admin - Datasets GetDatasetsInGroupAsAdmin

Returns a list of datasets from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets?$filter={$filter}&$top={$top}&$skip={$skip}&$expand={$expand}

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace id

$filter
query
  • string

Filters the results, based on a boolean condition

$top
query
  • integer
int32

Returns only the first n results

$skip
query
  • integer
int32

Skips the first n results

$expand
query
  • string

Expands related entities inline

Responses

Name Type Description
200 OK

OK

Examples

Example
Example with expand on encryption

Example

Sample Request

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

Sample Response

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

Example with expand on encryption

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "encryption": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "encryptionStatus": "InSyncWithWorkspace"
      }
    }
  ]
}

Definitions

Dataset

A Power BI dataset

Datasets

A dataset odata list wrapper

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

Dataset

A Power BI dataset

Name Type Description
Encryption

The dataset encryption information (Only applicable when $expand is specified)

IsEffectiveIdentityRequired
  • boolean

Dataset requires effective identity

IsEffectiveIdentityRolesRequired
  • boolean

Dataset requires roles

IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway

IsRefreshable
  • boolean

Can this dataset be refreshed

addRowsAPIEnabled
  • boolean

Whether dataset allows adding new rows

configuredBy
  • string

The dataset owner

id
  • string

The dataset id

name
  • string

The dataset name

webUrl
  • string

The dataset web url

Datasets

A dataset odata list wrapper

Name Type Description
odata.context
  • string

OData context

value

The datasets

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings

NotInSyncWithWorkspace
  • string

Encryption is supported and not in sync with the encryption settings

NotSupported
  • string

Encryption is not supported for this dataset

Unknown
  • string

Unable to determine state due to dataset corruption