Admin - Datasets GetDatasetsAsAdmin
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
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 |
|
Filters the results, based on a boolean condition |
|
$skip
|
query |
|
Skips the first n results |
|
$top
|
query |
|
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
{
"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 |
Datasource |
Datasource usage |
Dependent |
A Power BI Dependent dataflow |
Encryption |
Encryption information for a dataset |
Encryption |
Dataset encryption status |
Endorsement |
Power BI endorsement details |
Sensitivity |
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 |
|
The content provider type for the dataset |
CreateReportEmbedURL |
|
The dataset create report embed url |
CreatedDate |
|
DateTime of creation of this dataset |
Encryption |
The dataset encryption information (Only applicable when $expand is specified) |
|
IsEffectiveIdentityRequired |
|
Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API. |
IsEffectiveIdentityRolesRequired |
|
Whether RLS is defined inside the PBIX file. This indicates that you must specify a role. |
IsOnPremGatewayRequired |
|
Dataset requires an On-premises Data Gateway |
IsRefreshable |
|
Can this dataset be refreshed |
QnaEmbedURL |
|
The dataset qna embed url |
addRowsAPIEnabled |
|
Whether the dataset allows adding new rows |
configuredBy |
|
The dataset owner |
datasourceUsages |
Datasource usages |
|
description |
|
The dataset description |
endorsementDetails |
The dataset endorsement details |
|
id |
|
The dataset id |
name |
|
The dataset name |
sensitivityLabel |
The dataset sensitivity label |
|
upstreamDataflows |
Upstream Dataflows |
|
webUrl |
|
The dataset web url |
Datasets
A dataset odata list wrapper
Name | Type | Description |
---|---|---|
odata.context |
|
OData context |
value |
|
The datasets |
DatasourceUsage
Datasource usage
Name | Type | Description |
---|---|---|
datasourceInstanceId |
|
The datasource instance ID |
DependentDataflow
A Power BI Dependent dataflow
Name | Type | Description |
---|---|---|
groupId |
|
The target group id |
targetDataflowId |
|
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 |
|
Encryption is supported and is in sync with the encryption settings |
NotInSyncWithWorkspace |
|
Encryption is supported and not in sync with the encryption settings |
NotSupported |
|
Encryption is not supported for this dataset |
Unknown |
|
Unable to determine state due to dataset corruption |
EndorsementDetails
Power BI endorsement details
Name | Type | Description |
---|---|---|
certifiedBy |
|
The user that certified the artifact |
endorsement |
|
The endorsement status |
SensitivityLabel
Artifact sensitivity label info
Name | Type | Description |
---|---|---|
labelId |
|
The sensitivity label ID |