Microsoft Power Bi

Creates a new empty dashboard in the specified workspace. Use this action when you need to create a new dashboard in a Power BI workspace. The API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created dashboard will be empty and can be populated with tiles afterward using other APIs.

Returns a list of reports from the specified app. Use this action when you need to retrieve all reports that belong to a specific Power BI app. This is useful for exploring app contents, finding specific reports within apps, or managing app resources. Required Scope: Report.ReadWrite.All or Report.Read.All Limitations: Service principal authentication isn't supported.

Assigns the specified workspace to the specified capacity. Use this action when you need to assign a Power BI workspace to a dedicated capacity or unassign My workspace from a capacity by providing an empty GUID (00000000-0000-0000-0000-000000000000). This operation is typically performed by Fabric administrators to manage workspace capacity assignments. Note: The user must have appropriate permissions (Capacity.ReadWrite.All or workspace admin rights).

Cancels the specified refresh operation for the specified dataset from the specified workspace. Use this action when you need to cancel an in-progress dataset refresh operation within a specific Power BI workspace. This is useful for stopping long-running refreshes that are no longer needed or that appear to be stuck. Note that only refresh operations with status of Unknown or Queued can be canceled. Once a refresh has started processing, it cannot be cancelled. This action is irreversible - once a refresh is successfully cancelled, it cannot be resumed and must be triggered again manually. Required Scope: Dataset.ReadWrite.All

Clones the specified report from My workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a shared dataset is created. Use when you need to duplicate a report within My workspace or to another workspace. This is useful for creating backup copies of reports, testing modifications without affecting the original, or preparing reports for different audiences. Required Scope: Report.ReadWrite.All

Clones the specified report from the specified workspace. Use this action when you need to duplicate a Power BI report within the same workspace or to a different workspace. If the dataset for a cloned report resides in two different workspaces or in My workspace, then a share is required. The API returns the cloned report with a new ID. Required Scope: Report.ReadWrite.All

Creates a new goal value check-in for a Power BI scorecard goal. Use this action when you need to record a new value check-in for a specific goal within a Power BI scorecard. This action allows you to update the current value, target, status, trend, and forecast of a goal. The timestamp is required and represents the UTC time of the check-in. Required Scope: Dataset.ReadWrite.All

Creates a new workspace in Power BI. Use this action when you need to create a new Power BI workspace to organize reports, dashboards, datasets, and other Power BI content. This API call can be called by a service principal profile. Requires the Workspace.ReadWrite.All scope. Note: The created workspace will be empty and may require additional configuration such as assigning capacity or adding members.

Creates a new dataset on My workspace in Power BI. Use this action when you need to create a new push dataset to store and manage data that can be pushed programmatically via the Power BI REST API. This API call only supports push datasets (Push, Streaming, or PushStreaming mode). This action is irreversible once the dataset is created. The dataset name must be unique within the workspace.

Creates a new scorecard in the specified Power BI workspace. Use this action when you need to create a new scorecard to track business objectives and key results in a specific Power BI workspace. Scorecards help organizations monitor progress toward goals with customizable metrics, status rules, and reporting. Requires the Dataset.ReadWrite.All scope. This action is irreversible once the scorecard is created. The scorecard name must be unique within the workspace.

Creates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to the organization. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. This action creates an upload location at the organization level (myorg), not a specific workspace. To upload to a specific workspace, use CreateTemporaryUploadLocationInGroup instead. Required Scope: Workspace.ReadWrite.All

Creates a temporary blob storage upload location for importing large Power BI .pbix files that are between 1 GB and 10 GB in size. Use this action when you need to upload a large Power BI .pbix file (between 1 GB and 10 GB) to a workspace. The temporary upload location provides a shared access signature (SAS) URL where the file can be uploaded before being imported into Power BI. After uploading to the temporary location, you would use the regular import API to complete the import process. Required Scope: Workspace.ReadWrite.All

Deletes the specified dashboard from My workspace. Use this action when you need to permanently remove a dashboard from a user's Power BI workspace. This action is irreversible — once deleted, the dashboard and all its content cannot be recovered. Required Scope: Dashboard.ReadWrite.All

Deletes the specified dataflow from Power BI data prep storage, including its definition file and model. Use this action when you need to permanently remove a dataflow from a Power BI workspace. This action is irreversible — once deleted, the dataflow and all its associated data cannot be recovered. Permissions: The user must have administrator rights or the caller must be a service principal.

Deletes the specified dataset from My workspace. Use this action when you need to permanently remove a dataset from a user's Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Deletes the specified dataset from the specified workspace. Use this action when you need to permanently remove a dataset from a specific Power BI workspace. This action is irreversible — once deleted, the dataset and all its associated data cannot be recovered. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All

Deletes a goal from a scorecard by goal ID. Use this action when you need to permanently remove a goal from a Power BI scorecard. This action is irreversible — once deleted, the goal and its associated data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Deletes a goal value check-in note by its unique identifier. Use this action when you need to remove a specific check-in note from a goal value in Power BI goals. This action is irreversible — once deleted, the note cannot be recovered. Required Scope: Dataset.ReadWrite.All

Removes status rule definitions from a goal. Use this action when you need to remove all status rules from a specific goal within a Power BI scorecard. This action is irreversible — once deleted, the status rules and their configuration cannot be recovered. Required Scope: Dataset.ReadWrite.All

Removes user permissions from the specified deployment pipeline. Use this action when you need to revoke a user's access to a deployment pipeline. This action is irreversible — once removed, the user loses access to the pipeline. Required Scope: Pipeline.ReadWrite.All

Deletes the specified report from the specified workspace. Use this action when you need to permanently remove a report from a specific Power BI workspace. This action is irreversible — once deleted, the report and all its content cannot be recovered. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.All

Deletes all rows from the specified table within the specified dataset from My workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion. Required Scope: Dataset.ReadWrite.All

Deletes all rows from the specified table within the specified dataset from the specified workspace. Use this action when you need to clear all data from a specific table within a Power BI push dataset in a specific workspace. This action is irreversible — once deleted, the rows cannot be recovered. This operation is commonly used to reset test data or prepare a table for fresh data ingestion in a workspace context. Required Scope: Dataset.ReadWrite.All

Deletes a scorecard by its ID from the specified workspace. Use this action when you need to permanently remove a scorecard from a Power BI workspace. This action is irreversible — once deleted, the scorecard and all its data cannot be recovered. Required Scope: Dataset.ReadWrite.All

Deletes the specified workspace. Use this action when you need to permanently remove a Power BI workspace. This action is irreversible — once deleted, the workspace and all its content (reports, dashboards, datasets) cannot be recovered. Required Scope: Workspace.ReadWrite.All

Returns a list of gateways that the specified dataset from the specified workspace can be bound to. Use this action when you need to discover which on-premises data gateways are available to bind a dataset to for refresh and data source connections. This API call is only relevant for datasets that have at least one binding to an on-premises data source. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Executes Data Analysis Expressions (DAX) queries against the provided dataset in My workspace. Use this action when you need to run DAX queries to retrieve or analyze data from a Power BI dataset. This endpoint supports complex DAX queries with multiple EVALUATE statements and includes features for Row-Level Security (RLS), culture-specific formatting, and custom data injection. The response is returned in Apache Arrow format and contains the query results in a columnar format. Use pyarrow or similar libraries to parse the response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Important: This API is only available for datasets hosted on a capacity. Datasets with live connections to Azure Analysis Services or on-premises models are not supported. There's a limit of 120 query requests per minute per user.

Executes Data Analysis Expressions (DAX) queries against the specified Power BI dataset. Use this action when you need to run DAX queries to retrieve data, perform calculations, or analyze data directly from a Power BI dataset. DAX query errors (such as syntax errors or invalid references) will result in an error response. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Executes the Subscription specified by the Id. Use this action when you need to manually trigger a Power BI email subscription to run immediately instead of waiting for its scheduled frequency. This is useful for testing subscriptions, generating reports on-demand, or forcing an unscheduled distribution of a report. Note: The API returns 204 No Content on success with an empty body.

Generates an embed token to view or edit the specified dashboard from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI dashboard in your application. The token allows you to embed the dashboard with the specified access level. You can also configure row-level security (RLS) by providing identities. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Generates an embed token for multiple reports, datasets, and target workspaces. Use this action when you need to generate an embed token to embed Power BI reports, dashboards, or visuals in your application. Reports and datasets do not have to be related. The token can include identities for row-level security (RLS) and single sign-on (SSO) data sources.

Generates an embed token to view or edit the specified report from the specified workspace. Use this action when you need to generate an embed token to embed a Power BI report in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded report. You can also configure row-level security (RLS) by providing identities, customize the token lifetime, and enable the allowSaveAs option for saving embedded reports as new reports. Required Scope: Report.ReadWrite.All or Report.Read.All

Generates an embed token based on the specified dataset from the specified workspace. Use this action when you need to generate an embed token to embed Power BI reports or dashboards using a specific dataset from a workspace in your application. The token allows you to control the access level (View, Edit, or Create) for the embedded content. You can also configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns the specified available feature for the user by name. Use this action when you need to check the availability and status of a specific Power BI feature, such as embedTrial. This API call doesn't require any scopes. Note: The featureName path parameter should be URL-encoded if it contains special characters.

Returns a list of Power BI capacities that the authenticated user has access to. Use this action to retrieve information about all available capacities in the organization, including their state, SKU, region, and access permissions. This is useful for admin operations and capacity management tasks. Permissions: Requires one of the following scopes: Capacity.Read.All or Capacity.ReadWrite.All. This API call can be called by a service principal profile.

Returns the specified dashboard from My workspace. Use when you need to retrieve details about a specific dashboard from the current user's personal workspace in Power BI. This is useful for getting dashboard metadata, embed URLs, or user permissions. Required Scope: Dashboard.ReadWrite.All or Dashboard.Read.All

Returns a list of dashboards from the specified workspace. Use this action when you need to retrieve all dashboards within a Power BI workspace. This is useful for exploring workspace contents, finding specific dashboard IDs, or managing dashboard resources. Permissions: This API call can be called by a service principal profile.

Returns a list of all dataflows from the specified workspace. Use this action when you need to retrieve all dataflows within a specific Power BI workspace. This is useful for inventory, monitoring, or managing dataflows within a workspace. This API call can be called by a service principal profile. Required Scope: Dataflow.Read.All or Dataflow.ReadWrite.All

Returns the specified dataset from My workspace. Use this action when you need to retrieve details about a specific Power BI dataset in your workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns the specified dataset from the specified workspace. Use this action when you need to retrieve details about a specific Power BI dataset in a workspace, including its configuration, permissions, and relationships to other artifacts like dataflows and tables. Permissions: This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Gets the query results for the specified DataSet. Use when you need to retrieve the actual data values from a Power BI DataSet, such as for exporting data, generating reports outside of Power BI, or performing data analysis on dataset contents. This action executes a query against the dataset and returns the column definitions and row data. Use the optional parameters to filter or customize the query results.

Returns a list of datasets from My workspace. Use when you need to retrieve all datasets available in the authenticated user's personal workspace, including their configuration and metadata. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Gets an array of DataSet CatalogItems from Power BI. Use when you need to retrieve all available datasets from the Power BI service, including their metadata such as creation date, modified date, owner, and dataset-specific properties like query timeout and parameters. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns a list of upstream dataflows for datasets from the specified workspace. Use this action when you need to retrieve the relationships between datasets and their upstream dataflows in a Power BI workspace for dependency analysis or lineage tracking. This API call can be called by a service principal profile.

Returns a list of principals that have access to the specified dataset. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.

Returns a list of principals that have access to the specified dataset within a workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI dataset within a workspace. This is useful for auditing dataset permissions, managing access control, or understanding who can view or modify the dataset in a group context. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available.

Returns a list of data sources for the specified dataset from My workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns a list of data sources for the specified dataset from the specified workspace. Use when you need to retrieve all data source connections configured for a specific Power BI dataset within a workspace, such as when auditing data sources, troubleshooting refresh issues, or understanding dataset dependencies. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns the specified gateway. Use this action when you need to retrieve details about a specific Power BI gateway, including its status, type, and public key for encryption. Permissions: The user must have gateway admin permissions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns a list of gateway data sources for the specified dataset from the specified workspace. Use this action when you need to retrieve all gateway data source connections configured for a specific Power BI dataset within a workspace. This is useful for auditing data source configurations, troubleshooting refresh issues, or understanding dataset dependencies. This API is deprecated - use Get Datasources In Group instead.

Returns a list of gateways for which the user is an admin. Use this action when you need to retrieve all Power BI gateways that you have administrative permissions for. This is useful for monitoring gateway status, managing data sources, or administering on-premises data gateway configurations. Gateway admin permissions are required to access this endpoint.

Returns a list of goals from a scorecard. Use this action when you need to retrieve all goals defined within a Power BI scorecard. This is useful for understanding the organizational objectives and key results (OKRs) tracked in Power BI, finding specific goal IDs, or monitoring progress against targets. This API call can be called by a service principal profile. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Reads refresh history of a connected goal. Use this action when you need to retrieve the refresh history for a specific Power BI goal to monitor refresh performance, identify failed refreshes, or audit refresh operations on goals. This endpoint is part of the Power BI Goals (Preview) API. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All Note: This is a preview API and may be subject to changes.

Returns status rules of a goal. Use this action when you need to retrieve the status rules configuration for a specific Power BI goal within a scorecard. Status rules determine how goal status is calculated based on conditions (e.g., if actual value > 50% of target, status is "On track"). This action supports reading both simple expression-based conditions and complex field comparison conditions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Reads a goal value check-in by a UTC date timestamp. Use this action when you need to retrieve a specific goal value check-in from a Power BI scorecard. This is useful for tracking historical goal values, reviewing notes on goal progress, or analyzing trends. The timestamp must be provided in UTC format (e.g., 2024-05-12T00:00:00Z). Required Scope: Dataset.Read.All or Dataset.ReadWrite.All

Returns a list of workspaces the user has access to. Use this action when you need to retrieve all Power BI workspaces (groups) that the authenticated user has access to. This is useful for listing available workspaces, finding specific workspace IDs, or managing workspace resources. This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All

Gets the status of the assignment-to-capacity operation for the specified workspace. Use this action when you need to check the current status of a workspace assignment operation to a capacity. This is useful for monitoring long-running workspace migrations or diagnosing failed assignments. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All

Returns a list of users that have access to the specified workspace. Use this action when you need to retrieve the list of users or service principals who have been granted access to a specific Power BI workspace. This is useful for auditing workspace permissions, managing access control, or understanding who can view or modify the workspace contents. Permissions: This API call can be called by a service principal profile.

Returns the specified import from My workspace. Use this action when you need to retrieve details about a specific import in your Power BI workspace, including its status, associated datasets, and reports. This is useful for tracking import operations, checking whether an import succeeded or failed, and identifying related artifacts. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All

Returns a list of imports from My workspace. Use this action when you need to retrieve all imports in the authenticated user's personal workspace, including their status, associated datasets, and reports. This is useful for monitoring import operations, checking import completion status, or listing imported content in your workspace. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All