Dataflows - Get Dataflows

Service:: Power BI REST APIs

API Version:: v1.0

Returns a list of all dataflows from the specified workspace.

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

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace id

Responses

Name	Type	Description
200 OK	Dataflows	OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/a2f89923-421a-464e-bf4c-25eab39bb09f/dataflows

Sample Response

Status code:: 200

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

Definitions

Dataflow	The metadata of a dataflow
Dataflows	Odata response wrapper for a dataflow metadata list
DatasourceUsage	Datasource usage
DependentDataflow	A Power BI Dependent dataflow
EndorsementDetails	Power BI endorsement details
SensitivityLabel	Artifact sensitivity label info

Dataflow

The metadata of a dataflow

Name	Type	Description
configuredBy	string	The dataflow owner
datasourceUsages	DatasourceUsage[]	Datasource usages
description	string	The dataflow description
endorsementDetails	EndorsementDetails	The dataflow endorsement details
modelUrl	string	A URL to the dataflow definition file (model.json)
modifiedBy	string	The user that modified this dataflow
modifiedDateTime	string	modification date time
name	string	The dataflow name
objectId	string	The dataflow id
sensitivityLabel	SensitivityLabel	The dataflow sensitivity label
upstreamDataflows	DependentDataflow[]	Upstream Dataflows

Dataflows

Odata response wrapper for a dataflow metadata list

Name	Type	Description
odata.context	string
value	Dataflow[]	The dataflow metadata List

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

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