Share via

Datasets - Get Dataset

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

Returns the specified dataset from My workspace.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All 

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}

URI Parameters

Name In Required Type Description
datasetId
 path True

string

The dataset ID

Responses

Name Type Description
200 OK

Dataset

OK

Examples

Example

Sample request

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

Sample response

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

Definitions

Name Description
Dataset

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.
DatasetQueryScaleOutSettings

Query scale-out settings of a dataset
DatasetUser

A Power BI user access right entry for a dataset
DatasetUserAccessRight

The access right that the user has for the dataset (permission level)
DependentDataflow

A Power BI dependent dataflow
Encryption

Encryption information for a dataset
EncryptionStatus

Dataset encryption status
PrincipalType

The principal type
ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Dataset

Object

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

Name Type Description
ContentProviderType

string

A deprecated property that should be ignored.
Encryption

Encryption

Dataset encryption information. Only applicable when $expand is specified.
IsEffectiveIdentityRequired

boolean

Whether the dataset requires an effective identity, which you must send in a GenerateToken API call.
IsEffectiveIdentityRolesRequired

boolean

Whether row-level security is defined inside the Power BI .pbix file. If so, you must specify a role.
IsInPlaceSharingEnabled

boolean

Whether the dataset can be shared with external users to be consumed in their own tenant
IsOnPremGatewayRequired

boolean

Whether the dataset requires an on-premises data gateway
IsRefreshable

boolean

This field returns true when the dataset is either recently refreshed or is configured for automatic refresh, with the connection mode specifically set to 'Import'. The value will return false for other connection modes, such as 'DirectQuery' and 'LiveConnection', regardless of whether the dataset is manually refreshed or is set up for automatic refresh.
addRowsAPIEnabled

boolean

Whether the dataset allows adding new rows
configuredBy

string

The dataset owner
createReportEmbedURL

string

The dataset create report embed URL
createdDate

string (date-time)

The dataset creation date and time
description

string

The dataset description
id

string

The dataset ID
name

string

The dataset name
qnaEmbedURL

string

The dataset Q&A embed URL
queryScaleOutSettings

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset
targetStorageMode

string

The dataset storage mode
upstreamDataflows

DependentDataflow[]

The list of all the dataflows this item depends on
users

DatasetUser[]

(Empty value) The dataset user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dataset Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.
webUrl

string

The web URL of the dataset

DatasetQueryScaleOutSettings

Object

Query scale-out settings of a dataset

Name Type Description
autoSyncReadOnlyReplicas

boolean

Whether the dataset automatically syncs read-only replicas
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

Maximum number of read-only replicas for the dataset (0-64, -1 for automatic number of replicas)

DatasetUser

Object

A Power BI user access right entry for a dataset

Name Type Description
datasetUserAccessRight

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)
displayName

string

Display name of the principal
emailAddress

string

Email address of the user
graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.
identifier

string

Identifier of the principal
principalType

PrincipalType

The principal type
profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
userType

string

Type of the user.

DatasetUserAccessRight

Enumeration

The access right that the user has for the dataset (permission level)

Value Description
None

Removes permission to the content in the dataset
Read

Grants Read access to the content in the dataset
ReadWrite

Grants Read and Write access to the content in the dataset
ReadReshare

Grants Read and Reshare access to the content in the dataset
ReadWriteReshare

Grants Read, Write, and Reshare access to the content in the dataset
ReadExplore

Grants Read and Explore access to the content in the dataset
ReadReshareExplore

Grants Read, Reshare, and Explore access to the content in the dataset
ReadWriteExplore

Grants Read, Write, and Explore access to the content in the dataset
ReadWriteReshareExplore

Grants Read, Write, Reshare, and Explore access to the content in the dataset

DependentDataflow

Object

A Power BI dependent dataflow

Name Type Description
groupId

string

The target group ID
targetDataflowId

string

The target dataflow ID

Encryption

Object

Encryption information for a dataset

Name Type Description
EncryptionStatus

EncryptionStatus

Dataset encryption status

EncryptionStatus

Enumeration

Dataset encryption status

Value Description
Unknown

The encryption status is unknown due to dataset corruption
NotSupported

Encryption isn't supported for this dataset
InSyncWithWorkspace

Encryption is supported and is in sync with the encryption settings
NotInSyncWithWorkspace

Encryption is supported but isn't in sync with the encryption settings

PrincipalType

Enumeration

The principal type

Value Description
None

No principal type. Use for whole organization level access.
User

User principal type
Group

Group principal type
App

Service principal type

ServicePrincipalProfile

Object

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName

string

The service principal profile name
id

string (uuid)

The service principal profile ID