View as Markdown
Microsoft Power BI icon

Microsoft Power BI ACTION

Refresh Dataset

Trigger a refresh of a Power BI dataset. Returns 202 Accepted on success; the request ID is available in the Location response header (last path segment) and x-ms-request-id header — use Get Refresh History to check status. Use List Datasets first to resolve a dataset name → datasetId. Pass workspaceId (from List Workspaces) or workspaceName to target a specific workspace, or omit both for My workspace. notifyOption controls email notifications on refresh outcome: NoNotification (default), MailOnCompletion, or MailOnFailure. Power BI Pro licenses allow up to 8 scheduled refreshes per day; Premium allows 48. Note: Push datasets accept this endpoint but the refresh is metadata-only (tile refresh), not a data refresh — no cancellable history entry is produced. 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 Refresh Dataset 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-refresh-dataset",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_power_bi: { authProvisionId: "apn_xxxxxxx" },
    datasetId: "Dataset ID",
    workspaceId: "Workspace ID",
  },
})

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.

Refresh Dataset inputs
Property Type Description
datasetId Dataset ID string
ID of the dataset to refresh. Example: cfafbeb1-8037-4d0c-896e-a46fb27ff229. Use List Datasets to find IDs by name.
Required
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
notifyOption Notify Option string
Email notification behavior on refresh outcome. Allowed values: NoNotification (default), MailOnCompletion, MailOnFailure.
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-refresh-dataset
Version
0.1.2
App
Microsoft Power BI
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes