Datasets - Get Refresh History

Returns the refresh history of the specified dataset from "My 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/datasets/{datasetId}/refreshes
GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes?$top={$top}

URI Parameters

Name In Required Type Description
datasetId
path True
  • string

The dataset id

$top
query
  • integer

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

Responses

Name Type Description
200 OK

OK

Examples

completed refresh example
Failed refresh example
in progress refresh example

completed refresh example

Sample Request

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

Sample Response

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "status": "Completed",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

Failed refresh example

Sample Request

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

Sample Response

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
      "status": "Failed",
      "requestId": "11bf290a-346b-48b7-8973-c5df149337ff"
    }
  ]
}

in progress refresh example

Sample Request

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

Sample Response

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

Definitions

Refresh

A Power BI refresh history entry

Refreshes

Odata response wrapper for a Power BI refresh history

RefreshType

Type of refresh request

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

requestId
  • string

The identifier of the Refresh request.
Please provide this identifier in all service requests

serviceExceptionJson
  • string

Failure error code in json format (not empty 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.

Refreshes

Odata response wrapper for a Power BI refresh history

Name Type Description
odata.context
  • string
value

The Refresh history list

RefreshType

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