Reports - Export Report In Group

Exports the specified report from the specified workspace to a Power BI .pbix or .rdl file.

  • For .pbix reports - You can set the preferClientRouting URL query parameter to true as a workaround for timeout issues.
  • Large files are downloaded to a temporary blob. Their URL is returned in the response and stored in the locally downloaded Power BI .pbix file.
  • For more information on requirements and limitations, see Download a report from the Power BI service to Power BI Desktop.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Note

Try-it feature is not supported for this API. See Export Power BI Report Powershell script for an example of how to use this API.

Required Scope

Report.ReadWrite.All or both Report.Read.All and Dataset.Read.All

Limitations

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/Export
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/Export?downloadType={downloadType}

URI Parameters

Name In Required Type Description
groupId
path True

string

uuid

The workspace ID

reportId
path True

string

uuid

The report ID

downloadType
query

DownloadType

The type of download. Valid values are LiveConnect and IncludeModel

Responses

Name Type Description
200 OK

file

Exported File

Media Types: "application/zip", "application/octet-stream"

Definitions

DownloadType

The type of download. Valid values are LiveConnect and IncludeModel

Name Type Description
IncludeModel

string

Export the report with the semantic model included.

LiveConnect

string

Export the report with a live connection to the semantic model.