Admin - Dataflows GetDataflowsAsAdmin

Returns a list of dataflows for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

When running under service prinicipal authentication, an app must not have any admin-consent required premissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

GET https://api.powerbi.com/v1.0/myorg/admin/dataflows
GET https://api.powerbi.com/v1.0/myorg/admin/dataflows?$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/dataflows

Sample Response

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

Definitions

AdminDataflow

The metadata of a dataflow returned by Admin APIs. Below is a list of properties that may be returned for a dataflow. 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.

AdminDataflows

OData response wrapper for a Power BI Admin dataflow collection

DataflowUser

A Power BI user access right entry for a dataflow

DataflowUserAccessRight

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

PrincipalType

The principal type

ServicePrincipalProfile

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

AdminDataflow

The metadata of a dataflow returned by Admin APIs. Below is a list of properties that may be returned for a dataflow. 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
configuredBy
  • string

The dataflow owner

description
  • string

The dataflow description

modelUrl
  • string

A URL to the dataflow definition file (model.json)

modifiedBy
  • string

The user that modified the dataflow

modifiedDateTime
  • string

The date and time that the dataflow was last modified

name
  • string

The dataflow name

objectId
  • string

The dataflow ID

users

(Empty value) The dataflow 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 dataflow by using the Get Dataflow Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUser parameter.

workspaceId
  • string

The dataflow workspace ID.

AdminDataflows

OData response wrapper for a Power BI Admin dataflow collection

Name Type Description
odata.context
  • string

OData context

value

The report collection

DataflowUser

A Power BI user access right entry for a dataflow

Name Type Description
DataflowUserAccessRight

The access right that a user has for the dataflow (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

The principal type

profile

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

userType
  • string

Type of the user.

DataflowUserAccessRight

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

Name Type Description
None
  • string

Removes permission to content in dataflow

Owner
  • string

Grants Read, Write and Reshare access to content in dataflow

Read
  • string

Grants Read access to content in dataflow

ReadReshare
  • string

Grants Read and Reshare access to content in dataflow

ReadWrite
  • string

Grants Read and Write access to content in dataflow

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

ServicePrincipalProfile

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

The service principal profile ID