View as Markdown
Microsoft Power BI icon

Microsoft Power BI ACTION

Export Report

Export a Power BI report to a file format such as PDF, PPTX, or PNG. Requires a report ID (use List Reports to find it) and defaults to PDF if no format is given. Pass workspaceId (from List Workspaces) or workspaceName to target a specific workspace, or omit both for My workspace. Supported format values depend on the report type: Power BI reports support PDF, PPTX, PNG. Paginated reports additionally support CSV, XLSX, DOCX, XML, MHTML. This API is Premium-only: requires the workspace to be backed by Premium capacity, Premium Per User, or Embedded capacity. On shared (free) capacity it returns FixedCapacityLimitExceeded / 403. The export is asynchronous — this tool starts the export, then polls until the job reaches Succeeded or Failed (or pollTimeoutSeconds elapses), then downloads the file and returns it as base64 along with the job metadata. PNG exports only work for single-page reports. For PPTX/PDF, pass pages (array of page names, e.g., ["ReportSection", "ReportSection1"]) to limit the export. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft Power BI account once, then configure and run Export Report from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_power_bi-export-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_power_bi: { authProvisionId: "apn_xxxxxxx" },
    reportId: "Report ID",
    format: "Format",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Export Report inputs
Property Type Description
reportId Report ID string
ID of the report to export. Use List Reports to find IDs by name.
Required
format Format string
Output file format. Defaults to PDF. PDF/PPTX/PNG work for Power BI reports (PNG is single-page only). CSV/XLSX/DOCX/XML/MHTML are only supported for paginated reports.
Optional
workspaceId Workspace ID string
ID of the workspace. Use the List Workspaces tool to see accessible workspaces. Omit to target My workspace.
Optional
workspaceName Workspace Name string
Name of the workspace (alternative to Workspace ID). Use the List Workspaces tool to see accessible workspaces.
Optional
pages Pages string[]
Optional list of page names to include in the export. Page names are from the report's internal section IDs (e.g., ReportSection1), not visible page titles. If omitted, all pages are exported.
Optional
pollIntervalSeconds Poll Interval (seconds) integer
How often to poll the export job status. Minimum 1.
Optional
pollTimeoutSeconds Poll Timeout (seconds) integer
Maximum time to wait for the export to complete before returning the in-progress job metadata. Default 300s.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
microsoft_power_bi-export-report
Version
0.0.3
App
Microsoft Power BI
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes