Datasets - Get Refresh Execution Details

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Returns execution details of an enhanced refresh operation for the specified dataset from My workspace.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes/{refreshId}

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string (uuid)	The dataset ID
refreshId	path	True	string (uuid)	The refresh ID

Responses

Name	Type	Description
200 OK	DatasetRefreshDetail	OK (this response is returned when the refresh operation has completed or failed)
202 Accepted	DatasetRefreshDetail	Accepted (this response is returned when the refresh operation is still in progress)

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/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e

Sample response

Status code:: 200

{
  "startTime": "2021-12-10T08:40:31.57",
  "endTime": "2021-12-10T08:40:43.87",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Completed",
  "extendedStatus": "Completed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "objects": [
    {
      "table": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067",
      "partition": "DateTableTemplate_78e78207-b3fb-41b5-8b95-e5efca989067-ae306fb4-3b7e-4a41-824d-cb3b452fedfc",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051",
      "partition": "LocalDateTable_e9d8a66b-4018-4d16-be8c-402b2037c051-59bc07f8-85c9-456a-ad36-18e1de4d77ed",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e",
      "partition": "LocalDateTable_55935f6b-04d1-4cfe-8856-ed9f9e73ab2e-d95ae7f7-19c9-48a8-9c16-fcab26558bc2",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c",
      "partition": "LocalDateTable_ff25f80e-eb04-4229-986d-b40223c04f1c-6606fc4c-4cda-49e1-8acd-e55a6ec36cb3",
      "status": "Completed"
    },
    {
      "table": "DimCurrency",
      "partition": "DimCurrency-e5524cc4-a898-433b-91aa-c001b9a6d676",
      "status": "Completed"
    },
    {
      "table": "DimCustomer",
      "partition": "DimCustomer-a31bbd93-e20a-4dee-a33c-7afa27785953",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d",
      "partition": "LocalDateTable_fa65a206-f320-4d5d-abcc-1dc0f051ca7d-06a48a0a-a32b-48a3-b113-924aafd6363c",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2",
      "partition": "LocalDateTable_78a4e1b7-a2e5-4bbf-ab68-7c87961b68a2-5b3ba715-7c84-4e52-b310-485b93cfbe6d",
      "status": "Completed"
    },
    {
      "table": "DimDate",
      "partition": "DimDate-62e2f91b-53e5-4ed3-8618-fec74dba5e0d",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3",
      "partition": "LocalDateTable_e72c294f-0a06-4051-b943-e6bf8389e2c3-891a0e68-d414-4ba3-9c4b-e6f1ec73d4f3",
      "status": "Completed"
    },
    {
      "table": "DimProduct",
      "partition": "DimProduct-3d07cc89-2bd7-4a98-bb37-3368c1562f98",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92",
      "partition": "LocalDateTable_e37e4431-8c1a-449c-8796-b704df200a92-8596ebb8-418f-4e50-a921-dac88c6f1339",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0",
      "partition": "LocalDateTable_73faffeb-a0c7-4ea1-83dc-530823b0fea0-13795c4e-708f-4ddc-8ea3-5a2f39ae2253",
      "status": "Completed"
    },
    {
      "table": "DimPromotion",
      "partition": "DimPromotion-21e6c333-430e-4350-8c94-cdceb362c4c7",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8",
      "partition": "LocalDateTable_9c19746b-db7d-4b7e-b95d-c66e4b8fefc8-395de144-ad53-41c0-9ec0-68bab6158d99",
      "status": "Completed"
    },
    {
      "table": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71",
      "partition": "LocalDateTable_d96435dd-6110-4246-996c-616c96125e71-891737ee-c46c-4b9f-bfa8-e4555004e20f",
      "status": "Completed"
    },
    {
      "table": "DimSalesTerritory",
      "partition": "DimSalesTerritory-6d88f938-13d5-49f8-899c-d11b3d346ad5",
      "status": "Completed"
    },
    {
      "table": "FactInternetSales",
      "status": "Completed"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:40:31.57",
      "endTime": "2021-12-10T08:40:43.87",
      "type": "Data"
    }
  ]
}

Failed refresh example

Sample request

GET https://api.powerbi.com/v1.0/myorg/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/351f7113-59bb-4e5e-8c1e-e15ae7414121

Sample response

Status code:: 200

{
  "startTime": "2021-12-10T08:39:28.517",
  "endTime": "2021-12-10T08:39:30.04",
  "type": "Full",
  "commitMode": "PartialBatch",
  "status": "Failed",
  "extendedStatus": "Failed",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0,
  "messages": [
    {
      "message": "RefreshApiRequest for table refresh using refresh policy must have the property 'CommitMode' = 'Transactional' instead of 'PartialBatch'.",
      "type": "Error"
    }
  ],
  "refreshAttempts": [
    {
      "attemptId": 1,
      "startTime": "2021-12-10T08:39:28.517",
      "endTime": "2021-12-10T08:39:30.04",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefresh_ShortMessage_ProcessingError\",\"errorDescription\":\"0xC112001C: Expression.Error: Forced Error. . The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC11C0006: The current operation was cancelled because another operation in the transaction failed.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\\n0xC112001C: The command has been canceled.. The exception was raised by the IDbCommand interface.\"}",
      "type": "Data"
    }
  ]
}

In progress refresh example

Sample request

GET https://api.powerbi.com/v1.0/myorg/datasets/f7fc6510-e151-42a3-850b-d0805a391db0/refreshes/630110f5-8f93-49c2-afee-bfc87072460c

Sample response

Status code:: 202

{
  "startTime": "2021-12-14T03:46:04.833",
  "type": "Full",
  "commitMode": "Transactional",
  "status": "Unknown",
  "extendedStatus": "NotStarted",
  "currentRefreshType": "Full",
  "numberOfAttempts": 0
}

Definitions

Name	Description
DatasetRefreshDetail	A Power BI refresh detail entry
DatasetRefreshDetailCommitMode	Determines if objects will be committed in batches or only when complete
DatasetRefreshDetailExtendedStatus	Dataset operation detailed status
DatasetRefreshDetailStatus	Dataset operation general status
DatasetRefreshDetailType	The type of processing to perform
DatasetRefreshObjects	Power BI dataset refresh target
EngineMessage	The error or warning message from engine for enhanced refresh
RefreshAttempt	Power BI automatically makes multiple attempts to refresh a dataset if it experiences a refresh failure. This object contains information about each refresh attempt.
RefreshAttemptType	The type of refresh attempt.
RefreshEngineErrorType	The type of the error

DatasetRefreshDetail

Object

A Power BI refresh detail entry

Name	Type	Description
commitMode	DatasetRefreshDetailCommitMode	Determines if objects will be committed in batches or only when complete
currentRefreshType	DatasetRefreshDetailType	The type of processing for the current iteration. This is useful when `commitMode` is set to `PartialBatch`
endTime	string (date-time)	The end date and time of the refresh (may be empty if a refresh is in progress)
extendedStatus	DatasetRefreshDetailExtendedStatus	Dataset operation detailed status
messages	EngineMessage[]	An array of engine error or warning messages for the refresh request
numberOfAttempts	integer	The number of attempts for the refresh request
objects	DatasetRefreshObjects[]	An array of objects included in the refresh request
refreshAttempts	RefreshAttempt[]	The refresh attempt list.
startTime	string (date-time)	The start date and time of the refresh
status	DatasetRefreshDetailStatus	Dataset operation general status
type	DatasetRefreshDetailType	The type of processing to perform

DatasetRefreshDetailCommitMode

Enumeration

Determines if objects will be committed in batches or only when complete

Value	Description
PartialBatch	Commit the refresh operation in batches
Transactional	Commit the whole refresh operation as a transaction

DatasetRefreshDetailExtendedStatus

Enumeration

Dataset operation detailed status

Value	Description
Cancelled	The refresh operation has been cancelled by customer
Completed	The refresh operation is successfully completed
Disabled	The refresh operation is disabled by a selective refresh
Failed	The refresh operation is unsuccessful
InProgress	The refresh operation is in progress
NotStarted	The refresh operation isn't started
TimedOut	The refresh operation is timed out
Unknown	The completion state is unknown

DatasetRefreshDetailStatus

Enumeration

Dataset operation general status

Value	Description
Completed	The refresh operation is successfully completed
Disabled	The refresh operation is disabled by a selective refresh
Failed	The refresh operation is unsuccessful
Unknown	The completion state is unknown or a refresh is in progress

DatasetRefreshDetailType

Enumeration

The type of processing to perform

Value	Description
Automatic	If the object needs to be refreshed and recalculated, refresh and recalculate the object and all its dependents. Applies if the partition is in a state other than Ready.
Calculate	Recalculate this object and all its dependents, but only if needed. This value doesn't force recalculation, except for volatile formulas.
ClearValues	Clear values in this object and all its dependents
DataOnly	Refresh data in this object and clear all dependents
Defragment	Defragment the data in the specified table. As data is added to or removed from a table, the dictionaries of each column can become polluted with values that no longer exist in the actual column values. The defragment option will clean up the values in the dictionaries that are no longer used.
Full	For all partitions in the specified partition, table, or database, refresh data and recalculate all dependents. For a calculation partition, recalculate the partition and all its dependents.

DatasetRefreshObjects

Object

Power BI dataset refresh target

Name	Type	Description
partition	string	Partition to refresh
table	string	Table to refresh

EngineMessage

Object

The error or warning message from engine for enhanced refresh

Name	Type	Description
code	string	The error code in hex format
message	string	The text of error or warning message
type	RefreshEngineErrorType	The type of the error

RefreshAttempt

Object

Power BI automatically makes multiple attempts to refresh a dataset if it experiences a refresh failure. This object contains information about each refresh attempt.

Name	Type	Description
attemptId	integer	The index of the refresh attempt.
endTime	string (date-time)	The end date and time of the refresh attempt. The value is void if the refresh attempt is in progress.
serviceExceptionJson	string	Failure error code in JSON format. Void if there's no error.
startTime	string (date-time)	The start date and time of the refresh attempt.
type	RefreshAttemptType	The type of refresh attempt.

RefreshAttemptType

Enumeration

The type of refresh attempt.

Value	Description
Data	The refresh attempt to load data into the dataset.
Query	The attempt to refresh premium query caches and dashboard tiles.u

RefreshEngineErrorType

Enumeration

The type of the error

Value	Description
Error	Error message
Warning	Warning message

Share via

Datasets - Get Refresh Execution Details

Required Scope

URI Parameters

Responses

Examples

Completed refresh example

Sample request

Sample response

Failed refresh example

Sample request

Sample response

In progress refresh example

Sample request

Sample response

Definitions

DatasetRefreshDetail

DatasetRefreshDetailCommitMode

DatasetRefreshDetailExtendedStatus

DatasetRefreshDetailStatus

DatasetRefreshDetailType

DatasetRefreshObjects

EngineMessage

RefreshAttempt

RefreshAttemptType

RefreshEngineErrorType

Additional resources