Dataflows - Refresh Dataflow

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Triggers a refresh for the specified dataflow.

Supported email notification options are MailOnFailure and NoNotification. MailOnCompletion isn't supported.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataflow.ReadWrite.All

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

With optional parameters:

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	NotifyOption	Mail notification options

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

Request Body

{
  "notifyOption": "MailOnFailure"
}

Sample response

Status code:: 200

Definitions

Name	Description
NotifyOption	Mail notification options
RefreshRequest	Power BI refresh request

NotifyOption

Mail notification options

Name	Type	Description
MailOnCompletion	string	A mail notification indicating success or failure will be sent on refresh completion
MailOnFailure	string	A mail notification will be sent on refresh failure
NoNotification	string	No notification will be sent

RefreshRequest

Power BI refresh request

Name	Type	Description
notifyOption	NotifyOption	Mail notification options

Share via