Dataflows - Refresh Dataflow

Triggers a refresh for the specified dataflow. The only supported mail notification options are either in case of failure, or none. MailOnCompletion is not supported.

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

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshes
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshes?processType={processType}

URI Parameters

Name In Required Type Description
dataflowId
path True
  • string
uuid

The dataflow ID

groupId
path True
  • string
uuid

The workspace ID

processType
query
  • string
uuid

Type of refresh process to use.

Request Body

Name Required Type Description
notifyOption True

Mail notification options (success and/or failure, or none)

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021bd3a80abd/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshes?processType=default
{
  "notifyOption": "MailOnFailure"
}

Sample Response

Definitions

NotifyOption

Mail notification options (success and/or failure, or none)

RefreshRequest

Power BI refresh request

NotifyOption

Mail notification options (success and/or failure, or none)

Name Type Description
MailOnCompletion
  • string

Mail notification will be sent on refresh completion, including either failure and success

MailOnFailure
  • string

Mail notification will be sent on refresh failure

NoNotification
  • string

No notification will be sent

RefreshRequest

Power BI refresh request

Name Type Description
notifyOption

Mail notification options (success and/or failure, or none)