Get dataset refresh history
Updated: August 24, 2017
Request | Response | Example | Try on Apiary | Client and web app samples
The Get dataset refresh history operation returns a JSON list of a Refresh entities.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
GET https://api.powerbi.com/v1.0/myorg/datasets/{dataset_id}/refreshes/?$top={N}
Groups
Groups are a collection of unified Azure Active Directory groups that the user is a member of and is available in the Power BI service. These are referred to as app workspaces within the Power BI service. To learn how to create a group, see Create an app workspace.
GET https://api.powerbi.com/v1.0/myorg/groups/{group_id}/datasets/{dataset_id}/refreshes/?$top={N}
Uri parameter
| Name | Description | Data Type |
|---|---|---|
| group_id | Guid of the app workspace to use. You can get the group id from the Get Groups operation. Groups are referred to as app workspaces within the Power BI service. | String |
| dataset_id | Guid of the dataset to use. You can get the dataset id from the Get datasets operation. | String |
Query string parameter
| Name | Description | Values |
|---|---|---|
| $top | Optional. Used to limit the number of items returned. When polling for a current on-demand, Scheduled, or API-initiated refresh termination, it is advisable to use /?$top=1. | An integer value. |
Header
Authorization: Bearer eyJ0eX ... FWSXfwtQ
List of dataset refresh history entities ordered by start time (descending order). For a list of field values, see the refresh history entities.
Body schema
{
"odata.context": "string",
"value": [
{
"refreshType": "string",
"startTime": "2017-07-21T19:22:57.268Z",
"endTime": "2017-07-21T19:22:57.268Z",
"serviceExceptionJson": "string",
"status": "string"
}
]
}
Body example
{
"endTime":"2017-06-13T09:31:43.153Z",
"Id": "823456",
"serviceExceptionJson": empty,
"startTime":"2017-06-13T09:25:43.153Z",
"name":"SalesMarketing" ,
"status":"Completed"
}
Status code
| Code | Description |
|---|---|
| 200 | OK. |
| 400 | General failure |
| 403 | Unauthorized |
| 404 | Not found |
Content-Type
application/json