Power BI icon

Power BI

Work with the Power BI API

Report → Export To File

AI-generated

Summary

Export a Power BI report or paginated report file from a specified workspace, with options to configure export format, report settings, and wait behavior.

Inputs

  • Workspace Name or ID (required) — The ID of the Power BI workspace (group) containing the report. Choose from the list or specify using an expression.
  • Report Name or ID (required) — The ID of the report to export. Choose from the list or specify using an expression.
  • Report Type (required) — Select the type of report to export: 'Power BI Report' or 'Paginated Report'.
  • Export Format (required) — The format to export the report to, varying by report type. For Power BI reports: PDF, PNG, or PowerPoint (PPTX). For paginated reports: Accessible PDF, CSV, various image formats, MHTML, Excel (XLSX), Word (DOCX), PDF, or XML.
  • Wait For Completion (required) — Whether to wait for the export process to complete before returning the result.
  • Download File — If waiting for completion, whether to make the exported file available as binary data for download and as base64 string for use in integrations.
  • Additional Fields — Optional parameters including 'Maximum Wait Time' (seconds to wait for completion) and 'Polling Interval' (seconds between status checks).
  • Power BI Report Configuration — Settings specific to Power BI reports such as dataset binding, bookmarks, pages to export, identities for Row-Level Security, inclusion of hidden pages, locale, and report-level filters.
  • Paginated Report Configuration — Settings specific to paginated reports including format-specific settings, identities for Row-Level Security, locale, and report parameters.

Output shape

a single JSON object with export status and, if requested and waitForCompletion is true, includes the exported file as binary and base64 encoded data

If 'Wait For Completion' is true and 'Download File' is enabled, the operation returns the exported report file as binary data and a base64 string in the 'fileBase64' field. Export completion is polled up to 'Maximum Wait Time' with intervals defined by 'Polling Interval'. If 'Wait For Completion' is false, the operation returns export initiation details but not the file data.

Examples

Example 1: Export a Power BI report as PDF and download the file

Provide workspace and report IDs, select 'Power BI Report' as Report Type, choose 'PDF' for Export Format, enable 'Wait For Completion' and 'Download File'.

Example 2: Export a paginated report as Excel with parameters

Specify workspace and report, select 'Paginated Report' and 'XLSX' format, enable 'Wait For Completion', configure report parameters in 'Paginated Report Configuration'.

Discussion