pbi_dataset_refresh_hist {powerbiR} | R Documentation |
Refresh history of a dataset
Description
Returns the refresh history for the specified dataset from the specified workspace.
Usage
pbi_dataset_refresh_hist(group_id, dataset_id, top = NULL, request_id = NULL)
Arguments
group_id |
The workspace ID |
dataset_id |
The dataset ID |
top |
The number of most recent entries in the refresh history. The default is all available entries. |
request_id |
The request ID returned by pbi_dataset_refresh(). If provided the refresh status of the request ID is returned. |
Details
By default the function will return all historical refreshes. You
can reduce the list to the most recent refreshes using the top
argument.
If request_id
is provided the function will return a single refresh
status, but will still query the Power BI API for all historical entries.
If you query the top 5 most recent refreshes using the top
argument,
the function will only return a status if the provided request_id is in
this list.
The status value return can be either 'Completed', 'Failed' or 'Unknown', which means that the refresh is still in progress.
Value
A data frame with status, start and end times of historical refreshes
or a single refresh status message if request_id
is used.
See Also
Examples
## Not run:
group_id <- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
dataset_id <- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
pbi_dataset_refresh_hist(group_id, dataset_id)
## End(Not run)