Power BI icon

Power BI

Work with the Power BI API

Overview

This node integrates with the Power BI API to export reports from a specified workspace (group). It supports exporting two types of reports: Power BI Reports and Paginated Reports, allowing users to choose various export formats such as PDF, PNG, PowerPoint, Excel, Word, CSV, and more.

Typical use cases include:

  • Automating report exports for archival or distribution.
  • Generating report files in different formats for sharing via email or messaging platforms.
  • Integrating report exports into workflows that require report data in binary or base64 format for further processing or delivery (e.g., sending reports over WhatsApp).

For example, a user can configure the node to export a Power BI report as a PDF file, wait for the export to complete, and then download the file for immediate use or storage.

Properties

Name Meaning
Workspace Name or ID The ID of the workspace (group) containing the report. Choose from a list or specify an ID using an expression.
Report Name or ID The ID of the report to export. Depends on the selected workspace. Choose from a list or specify an ID using an expression.
Report Type Type of report to export. Options: "Power BI Report" or "Paginated Report".
Export Format Format to export the report to. For Power BI Reports: PDF, PNG, PowerPoint (PPTX). For Paginated Reports: PDF, Accessible PDF, CSV, Image (BMP, EMF, GIF, JPEG, PNG, TIFF), Microsoft Excel (XLSX), Microsoft Word (DOCX), MHTML, XML.
Wait For Completion Whether to wait until the export process completes before returning the result.
Baixar Arquivo (Download File) If enabled and waiting for completion, the exported file will be available as a binary file for download and also as a base64 string in the fileBase64 field for use in integrations like WhatsApp.
Additional Fields Collection of optional settings:
- Maximum Wait Time (seconds): Max time to wait for export completion.
- Polling Interval (seconds): Interval between status checks during export.
Power BI Report Configuration Settings specific to Power BI Reports:
- Include Hidden Pages (boolean)
- Locale (string, e.g., "en-US")
- Export Specific Pages (boolean) with JSON array of pages
- Use Report Level Filters (boolean) with JSON filters
- Use Default Bookmark (boolean) with bookmark name and state
- Use Alternative Dataset (boolean) with dataset ID
- Use Identities (RLS) (boolean) with JSON identities for Row-Level Security
Paginated Report Configuration Settings specific to Paginated Reports:
- Locale (string)
- Use Parameters (boolean) with JSON array of parameter values
- Use Format Settings (boolean) with JSON object of format-specific settings
- Use Identities (RLS) (boolean) with JSON identities for Row-Level Security

Output

The node outputs an array of JSON objects representing the results of the export operation. When the export is completed and if the "Download File" option is enabled, the output includes:

  • A binary file attached under the binary property, which contains the exported report file ready for download.
  • A fileBase64 field in the JSON output containing the base64-encoded content of the exported file, useful for integrations requiring base64 strings (e.g., sending files via messaging services).

If the node is configured not to wait for completion, the output may contain metadata about the export job status instead of the actual file.

Dependencies

  • Requires a valid Power BI API authentication token (API key credential) configured in n8n credentials.
  • Access to the Power BI service with permissions to read workspaces, reports, and export them.
  • Network access to https://api.powerbi.com/v1.0/myorg.

Troubleshooting

  • Common Issues:

    • Invalid workspace or report IDs: Ensure the selected workspace and report exist and the IDs are correct.
    • Insufficient permissions: The API token must have adequate permissions to access and export reports.
    • Timeout waiting for export completion: Increase the "Maximum Wait Time" if large reports take longer to export.
    • Incorrect JSON formatting in configuration fields (pages, filters, parameters, identities): Validate JSON syntax carefully.
  • Error Messages:

    • "The resource "<resource>" is not supported!": Occurs if an unsupported resource is selected; verify the resource name.
    • API errors related to authentication or authorization: Check API credentials and permissions.
    • JSON parsing errors for configuration fields: Correct the JSON input format.

Links and References

Discussion