Datasets - Get Refresh History In Group

Returns the refresh history of the specified dataset from the specified workspace.

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

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/refreshes
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/refreshes?$top={$top}

URI Parameters

Name In Required Type Description
groupId
path True
  • string

The workspace id

datasetKey
path True
  • string

The dataset id

$top
query
  • integer

The requested number of entries in the refresh history. If not supported, the default is all available entries.

Responses

Name Type Description
200 OK

OK

Examples

completed refresh example
in progress refresh example

completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

{
  "value": [
    {
      "endTime": "2017-06-13T09:31:43.153Z",
      "Id": "823456",
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Completed"
    }
  ]
}

in progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

{
  "value": [
    {
      "Id": "823456",
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown"
    }
  ]
}

Definitions

ODataResponse[List[Refresh]]

Odata response wrapper for a Power BI refresh history

Refresh

A Power BI refresh history entry

RefreshTypeEnum

Type of refresh request

ODataResponse[List[Refresh]]

Odata response wrapper for a Power BI refresh history

Name Type Description
odata.context
  • string
value

The Refresh history list

Refresh

A Power BI refresh history entry

Name Type Description
endTime
  • string

DateTime of termination (may be empty if refresh is progress)

refreshType

Type of refresh request

serviceExceptionJson
  • string

Failure exception details in json format. Includes cluster, time, Request, and Activity IDs (only on error).

startTime
  • string

DateTime of start

status
  • string

'Unknown' - Unknown completion state or refresh is in progress. endTime will be empty with this status.
'Completed' - refresh completed successfully
'Failed' - Refresh failed. serviceExceptionJson will contain the error.
'Disabled' - Refresh disabled by Selective Refresh.

RefreshTypeEnum

Type of refresh request

Name Type Description
OnDemand
  • string

Refresh was triggered interactively threw Power BI portal

Scheduled
  • string

Refresh was triggered by the dataset refresh schedule setting

ViaApi
  • string

Refresh was triggered by an Api call