Admin - Datasets GetDatasetsAsAdmin

Service:
Power BI REST APIs
API Version:
v1.0

Returns a list of datasets for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 2 seconds, in the mean time other requests will be queued.

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/datasets
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/datasets?$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
$filter
 query
  • string

Filters the results, based on a boolean condition
$skip
 query
  • integer
int32

Skips the first n results
$top
 query
  • integer
int32

Returns only the first n results

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/datasets

Sample Response

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

Definitions

Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.
Datasets

A dataset odata list wrapper
DatasourceUsage

Datasource usage
DependentDataflow

A Power BI Dependent dataflow
Encryption

Encryption information for a dataset
EncryptionStatus

Dataset encryption status
EndorsementDetails

Power BI endorsement details
SensitivityLabel

Artifact sensitivity label info

Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
ContentProviderType
  • string

The content provider type for the dataset
CreateReportEmbedURL
  • string

The dataset create report embed url
CreatedDate
  • string

DateTime of creation of this dataset
Encryption

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

Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.
IsEffectiveIdentityRolesRequired
  • boolean

Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.
IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway
IsRefreshable
  • boolean

Can this dataset be refreshed
QnaEmbedURL
  • string

The dataset qna embed url
addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows
configuredBy
  • string

The dataset owner
datasourceUsages

Datasource usages
description
  • string

The dataset description
endorsementDetails

The dataset endorsement details
id
  • string

The dataset id
name
  • string

The dataset name
sensitivityLabel

The dataset sensitivity label
upstreamDataflows

Upstream Dataflows
webUrl
  • string

The dataset web url

Datasets

A dataset odata list wrapper

Name Type Description
odata.context
  • string

OData context
value

The datasets

DatasourceUsage

Datasource usage

Name Type Description
datasourceInstanceId
  • string

The datasource instance ID

DependentDataflow

A Power BI Dependent dataflow

Name Type Description
groupId
  • string

The target group id
targetDataflowId
  • string

The target dataflow id

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

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact
endorsement
  • string

The endorsement status

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID