Reports - Get Export To File Status
Returns the current status of the Export to File job for the specified report from My workspace.
When the export job status is 'Succeeded' use the GetFileOfExportToFile API to retrieve the file.
Required Scope
Report.ReadWrite.All or Report.Read.All
GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
export
|
path | True |
string |
The export ID |
report
|
path | True |
string uuid |
The report ID |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Accepted |
Examples
Example
Sample request
GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}
Sample response
{
"id": "Mi9C5419i....PS4=",
"createdDateTime": "2021-12-08T10:26:09.3069086Z",
"lastActionDateTime": "2021-12-08T10:26:38.016851Z",
"reportId": "cad51cfa-e740-324f-acbb-8ca43c40a2d4",
"reportName": "Report name",
"status": "Succeeded",
"percentComplete": 100,
"resourceLocation": "...Mi9C5419i....PS4=/file",
"resourceFileExtension": ".pptx",
"expirationTime": "2021-12-09T10:26:11.586756Z"
}
Definitions
Name | Description |
---|---|
Export |
An object describing the details and current state of an export to file job |
Export |
The current state of the export to file job |
Export
An object describing the details and current state of an export to file job
Name | Type | Description |
---|---|---|
ResourceFileExtension |
string |
The extension of the exported file |
createdDateTime |
string |
The start date and time of the export to file job |
expirationTime |
string |
The expiration date and time of the retrieval URL |
id |
string |
The export to file job ID |
lastActionDateTime |
string |
The date and time of the last change to the export to file job |
percentComplete |
integer |
Job progress as a percentage |
reportId |
string |
The ID of the exported report |
reportName |
string |
The name of the exported report |
resourceLocation |
string |
The retrieval URL for the exported file |
status |
The current state of the export to file job |
ExportState
The current state of the export to file job
Name | Type | Description |
---|---|---|
Failed |
string |
The export to file job failed |
NotStarted |
string |
The export to file job didn't start |
Running |
string |
The export to file job is running |
Succeeded |
string |
The export to file job finished successfully |
Undefined |
string |
The state of the export to file job is undefined |