--- canonical_url: "https://docs.composio.dev/toolkits/microsoft_power_bi" markdown_url: "https://docs.composio.dev/toolkits/microsoft_power_bi.md" product: "platform" version: null last_updated: null --- # Microsoft Power Bi Microsoft Power BI is a business analytics service that provides interactive visualizations and business intelligence capabilities with an interface simple enough for end users to create their own reports and dashboards. - **Category:** business intelligence - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 116 - **Triggers:** 0 - **Slug:** `MICROSOFT_POWER_BI` - **Version:** 20260721_00 ## Tools ### Add Dashboard to Workspace **Slug:** `MICROSOFT_POWER_BI_ADD_DASHBOARD2` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the new dashboard | | `groupId` | string | Yes | The workspace ID (also known as group ID) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Reports From App **Slug:** `MICROSOFT_POWER_BI_APPS_GET_REPORTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `appId` | string | Yes | The app ID of the Power BI app whose reports to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign Workspace to Capacity **Slug:** `MICROSOFT_POWER_BI_ASSIGN_WORKSPACE_TO_CAPACITY` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace (group) ID. This is a path parameter identifying the target workspace. | | `capacityId` | string | Yes | The capacity ID. Use an empty GUID (00000000-0000-0000-0000-000000000000) to unassign My workspace from a capacity. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Cancel Dataset Refresh in Workspace **Slug:** `MICROSOFT_POWER_BI_CANCEL_REFRESH2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID. Use GetGroups to find the workspace ID. | | `datasetId` | string | Yes | The dataset ID. Use GetDatasetsInGroup to find the dataset ID within a workspace. | | `refreshId` | string | Yes | The refresh ID to cancel. This is the unique identifier of a refresh operation from the dataset refresh history. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone Report **Slug:** `MICROSOFT_POWER_BI_CLONE_REPORT2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name for the cloned report | | `report_id` | string | Yes | The report ID of the source report to clone | | `target_model_id` | string | No | Optional. The target dataset ID to associate with the cloned report. If not provided, the new report will be associated with the same dataset as the source report. | | `target_workspace_id` | string | No | Optional. The target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If not provided, the new report will be cloned within the same workspace as the source report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Clone Report in Workspace **Slug:** `MICROSOFT_POWER_BI_CLONE_REPORT_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name for the cloned report | | `group_id` | string | Yes | The workspace ID (group ID) | | `report_id` | string | Yes | The report ID | | `target_model_id` | string | No | The target dataset ID. If not provided, the new report will be associated with the same dataset as the source report | | `target_workspace_id` | string | No | The target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If not provided, the new report will be cloned within the same workspace as the source report | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Goal Value Check-in **Slug:** `MICROSOFT_POWER_BI_CREATE_GOAL_VALUE` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trend` | string ("0" | "1" | "2") | No | Goal trend values. | | `value` | number | No | The current value of the goal. | | `status` | string ("0" | "1" | "2" | "3" | "4" | "5") | No | Goal status ID values. | | `target` | number | No | The target value of the goal. | | `goal_id` | string | Yes | The unique identifier of the goal | | `forecast` | number | No | The value trend forecast of the goal. | | `group_id` | string | Yes | The unique identifier of the workspace containing the scorecard | | `timestamp` | string | Yes | The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero. | | `scorecard_id` | string | Yes | The unique identifier of the scorecard containing the goal | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workspace **Slug:** `MICROSOFT_POWER_BI_CREATE_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the workspace to create | | `workspaceV2` | boolean | No | (Preview feature) Whether to create a workspace V2. The only supported value is `true`. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Push Dataset **Slug:** `MICROSOFT_POWER_BI_CREATE_PUSH_DATASET` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the dataset to create. | | `tables` | array | Yes | The list of tables to create in the dataset. | | `datasources` | array | No | The data sources associated with this dataset. | | `default_mode` | string | No | The dataset mode or type. For push datasets, use 'Push'. | | `relationships` | array | No | The relationships between tables in this dataset. | | `default_retention_policy` | string ("None" | "basicFIFO") | No | Default retention policy for the dataset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Scorecard **Slug:** `MICROSOFT_POWER_BI_CREATE_SCORECARD` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The scorecard name. | | `group_id` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `description` | string | No | Optional. The scorecard description. | | `sensitivity_label_id` | string | No | Optional. The GUID of a sensitivity label. If you don't want to select a sensitivity label, use a null or empty GUID (00000000-0000-0000-0000-000000000000). If default labels are enabled and/or enforced, they will be applied on the scorecard and dataset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Temporary Upload Location **Slug:** `MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATION` 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 #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Temporary Upload Location **Slug:** `MICROSOFT_POWER_BI_CREATE_TEMPORARY_UPLOAD_LOCATION_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID (group ID) that identifies the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dashboard **Slug:** `MICROSOFT_POWER_BI_DELETE_DASHBOARD` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dashboardId` | string | Yes | The dashboard ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dataflow **Slug:** `MICROSOFT_POWER_BI_DELETE_DATAFLOW` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `dataflowId` | string | Yes | The dataflow ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dataset **Slug:** `MICROSOFT_POWER_BI_DELETE_DATASET` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dataset from Workspace **Slug:** `MICROSOFT_POWER_BI_DELETE_DATASET2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Goal **Slug:** `MICROSOFT_POWER_BI_DELETE_GOAL` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Goal Note by ID **Slug:** `MICROSOFT_POWER_BI_DELETE_GOAL_NOTE_BY_ID` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goalId` | string | Yes | The unique identifier of the goal | | `noteId` | string | Yes | The unique identifier of the goal check-in note | | `groupId` | string | Yes | The unique identifier of the workspace | | `timestamp` | string | Yes | The timestamp for the value of the goal (ISO 8601 format) | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Goal Status Rules **Slug:** `MICROSOFT_POWER_BI_DELETE_GOAL_STATUS_RULES` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Pipeline User **Slug:** `MICROSOFT_POWER_BI_DELETE_PIPELINE_USER` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | The user principal name (UPN) of the user. To delete a service principal or a security group, provide the Object ID. | | `pipelineId` | string | Yes | The deployment pipeline ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Report from Workspace **Slug:** `MICROSOFT_POWER_BI_DELETE_REPORT_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `reportId` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Rows from Dataset Table **Slug:** `MICROSOFT_POWER_BI_DELETE_ROWS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | | `tableName` | string | Yes | The table name from which to delete all rows | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Rows from Dataset Table in Workspace **Slug:** `MICROSOFT_POWER_BI_DELETE_ROWS_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace | | `datasetId` | string | Yes | The dataset ID | | `tableName` | string | Yes | The table name from which to delete all rows | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Scorecard By ID **Slug:** `MICROSOFT_POWER_BI_DELETE_SCORECARD_BY_ID` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The unique identifier of the workspace (group) | | `scorecardId` | string | Yes | The unique identifier of the scorecard to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Workspace **Slug:** `MICROSOFT_POWER_BI_DELETE_WORKSPACE` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Discover Gateways for Dataset **Slug:** `MICROSOFT_POWER_BI_DISCOVER_GATEWAYS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID that identifies the dataset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute DAX Queries **Slug:** `MICROSOFT_POWER_BI_EXECUTE_DAX_QUERIES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The DAX query text to execute. Supports single or multiple EVALUATE statements. | | `roles` | array | No | Roles assigned to the user for Row-Level Security (RLS). | | `culture` | string | No | Culture code that controls locale-specific query formatting, such as 'en-US'. For more information about supported culture codes, see Supported languages and countries/regions for Power BI. | | `dataset_id` | string | Yes | The dataset ID | | `custom_data` | string | No | Custom data for use in Dynamic RLS. Can be referenced by the model's CUSTOMDATA() function. | | `schema_only` | boolean | No | Whether the query must return only the schema without data. | | `memory_limit` | integer | No | Memory limit in KB for the query execution. | | `query_timeout` | integer | No | Query timeout in seconds. | | `effective_username` | string | No | Effective username for the query. Used for RLS and audit purposes. | | `result_set_row_count_limit` | integer | No | Maximum number of rows to return. Default is 1,000,000 rows. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute DAX Queries on Dataset **Slug:** `MICROSOFT_POWER_BI_EXECUTE_QUERIES_2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `queries` | array | Yes | The list of DAX queries to execute against the dataset. Each query will return its own result set. | | `group_id` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `dataset_id` | string | Yes | The dataset ID to execute queries against. | | `serializer_settings` | object | No | Serialization settings for query results. | | `impersonated_user_name` | string | No | The UPN of a user to be impersonated. If the model is not Row-Level Security (RLS) enabled, this will be ignored. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Execute Subscription **Slug:** `MICROSOFT_POWER_BI_EXECUTE_SUBSCRIPTION` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `Id` | string | Yes | The key (GUID) that uniquely identifies the subscription. GUID example: 01234567-89ab-cdef-0123-456789abcdef | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Dashboard Embed Token **Slug:** `MICROSOFT_POWER_BI_GENERATE_DASHBOARD_EMBED_TOKEN` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | No | The dataset ID used for report creation. Only applies when you generate an embed token for report creation. | | `identities` | array | No | A list of identities to use for row-level security rules. | | `accessLevel` | string ("View" | "Edit" | "Create") | Yes | The required access level for embed token generation. | | `allowSaveAs` | boolean | No | Whether an embedded report can be saved as a new report. The default value is `false`. Only applies when you generate an embed token for report embedding. | | `dashboardId` | string | Yes | The dashboard ID | | `lifetimeInMinutes` | integer | No | The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Embed Token for Power BI **Slug:** `MICROSOFT_POWER_BI_GENERATE_EMBED_TOKEN` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reports` | array | No | A list of reports to include in the embed token. Reports and datasets do not have to be related. | | `datasets` | array | No | A list of datasets to include in the embed token. Datasets and reports do not have to be related. | | `identities` | array | No | The list of identities to use for row-level security rules. | | `target_workspaces` | array | No | The list of workspaces that the embed token will allow saving to. | | `lifetime_in_minutes` | integer | No | The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the token's expiration time, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will set the default expiration time. | | `datasource_identities` | array | No | List of identities to use when connecting to data sources with Single Sign-On (SSO) enabled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Report Embed Token in Group **Slug:** `MICROSOFT_POWER_BI_GENERATE_REPORT_TOKEN_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID | | `report_id` | string | Yes | The report ID | | `dataset_id` | string | No | The dataset ID used for report creation. Only applies when you generate an embed token for report creation. | | `identities` | array | No | A list of identities to use for row-level security rules. | | `access_level` | string ("View" | "Edit" | "Create") | Yes | The required access level for embed token generation. | | `allow_save_as` | boolean | No | Whether an embedded report can be saved as a new report. The default value is `false`. Only applies when you generate an embed token for report embedding. | | `lifetime_in_minutes` | integer | No | The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Dataset Embed Token in Group **Slug:** `MICROSOFT_POWER_BI_GENERATE_TOKEN_IN_GROUP` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID | | `dataset_id` | string | Yes | The dataset ID | | `identities` | array | No | A list of identities to use for row-level security rules. | | `access_level` | string ("View" | "Edit" | "Create") | Yes | The required access level for embed token generation. | | `allow_save_as` | boolean | No | Whether an embedded report can be saved as a new report. The default value is `false`. Only applies when you generate an embed token for report embedding. | | `target_dataset_id` | string | No | The dataset ID used for report creation. Only applies when you generate an embed token for report creation. | | `lifetime_in_minutes` | integer | No | The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Available Feature By Name **Slug:** `MICROSOFT_POWER_BI_GET_AVAILABLE_FEATURE_BY_NAME` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `feature_name` | string | Yes | The feature name to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Capacities **Slug:** `MICROSOFT_POWER_BI_GET_CAPACITIES` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard from My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_DASHBOARD2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dashboardId` | string | Yes | The dashboard ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboards **Slug:** `MICROSOFT_POWER_BI_GET_DASHBOARDS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results | | `skip` | integer | No | Skips the first n results | | `filter` | string | No | Returns a subset of results based on OData filter query parameter condition | | `groupId` | string | Yes | The workspace ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataflows **Slug:** `MICROSOFT_POWER_BI_GET_DATAFLOWS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results | | `skip` | integer | No | Skips the first n results | | `filter` | string | No | Returns a subset of results based on OData filter query parameter condition. | | `groupId` | string | Yes | The workspace ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset **Slug:** `MICROSOFT_POWER_BI_GET_DATASET` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset in Workspace **Slug:** `MICROSOFT_POWER_BI_GET_DATASET2` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get DataSet Data **Slug:** `MICROSOFT_POWER_BI_GET_DATA_SET_DATA` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The key (GUID or path) that uniquely identifies the DataSet. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path='/folder1/folder2/item'. If the path contains single quotes, escape them by adding another single quote. | | `max_rows` | integer | No | Specifies the maximum number of rows to return from the query. | | `parameters` | array | No | An array of DataSet parameters to use when executing the query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Datasets from My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_DATASETS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results. Use with skip for pagination. | | `skip` | integer | No | Skips the first n results. Use with top for pagination. | | `expand` | string | No | Expands related entities inline (e.g., 'schema,tables,relationships'). | | `filter` | string | No | Returns a subset of results based on OData filter query parameter condition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get DataSets from Power BI **Slug:** `MICROSOFT_POWER_BI_GET_DATA_SETS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Show only the first n items. See OData Paging - Top. | | `skip` | integer | No | Skip the first n items. See OData Paging - Skip. | | `count` | string | No | Include count of items. See OData Count. | | `filter` | string | No | Filter items by property values. See OData Filtering. | | `select` | string | No | Select properties to be returned. See OData Select. | | `order_by` | string | No | Order items by property values. See OData Sorting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset to Dataflows Links **Slug:** `MICROSOFT_POWER_BI_GET_DATASET_TO_DATAFLOWS_LINKS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Users **Slug:** `MICROSOFT_POWER_BI_GET_DATASET_USERS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset_id` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Users In Group **Slug:** `MICROSOFT_POWER_BI_GET_DATASET_USERS_IN_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID | | `dataset_id` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Datasources for Dataset **Slug:** `MICROSOFT_POWER_BI_GET_DATASOURCES` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Datasources for Dataset in Workspace **Slug:** `MICROSOFT_POWER_BI_GET_DATASOURCES_IN_GROUP3` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Gateway **Slug:** `MICROSOFT_POWER_BI_GET_GATEWAY` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gatewayId` | string | Yes | The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Gateway Datasources in Group **Slug:** `MICROSOFT_POWER_BI_GET_GATEWAY_DATASOURCES_IN_GROUP` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Gateways **Slug:** `MICROSOFT_POWER_BI_GET_GATEWAYS` 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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Goals from Scorecard **Slug:** `MICROSOFT_POWER_BI_GET_GOALS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | string | No | Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports `goalValues` and `aggregations`. | | `select` | string | No | Allows the clients to select specific properties from the server. | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Goals Refresh History **Slug:** `MICROSOFT_POWER_BI_GET_GOALS_REFRESH_HISTORY` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goal_id` | string | Yes | The unique identifier of the goal to get refresh history for | | `group_id` | string | Yes | The unique identifier of the workspace (group) containing the scorecard and goal | | `scorecard_id` | string | Yes | The unique identifier of the scorecard containing the goal | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Goals Status Rules **Slug:** `MICROSOFT_POWER_BI_GET_GOALS_STATUS_RULES` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Goal Value By ID **Slug:** `MICROSOFT_POWER_BI_GET_GOAL_VALUE_BY_ID` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | string | No | Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports `notes`. | | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace | | `timestamp` | string | Yes | The timestamp for the value of the goal. Use UTC format (e.g., 2024-05-12T00:00:00Z) | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Groups **Slug:** `MICROSOFT_POWER_BI_GET_GROUPS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results. Defaults to 25 if not specified. | | `skip` | integer | No | Skips the first n results. | | `filter` | string | No | Returns a subset of results based on OData filter query parameter condition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Groups Capacity Assignment Status **Slug:** `MICROSOFT_POWER_BI_GET_GROUPS_CAPACITY_ASSIGNMENT_STATUS` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Group Users **Slug:** `MICROSOFT_POWER_BI_GET_GROUP_USERS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results | | `skip` | integer | No | Skips the first n results | | `group_id` | string | Yes | The workspace ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Import **Slug:** `MICROSOFT_POWER_BI_GET_IMPORT` 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 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `importId` | string | Yes | The import ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Imports from My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_IMPORTS2` 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 #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Imports in Workspace **Slug:** `MICROSOFT_POWER_BI_GET_IMPORTS_IN_GROUP` Returns a list of imports from the specified workspace. Use this action when you need to retrieve all imports in a Power BI workspace to monitor import status, list imported datasets and reports, or check for failed imports. This API can be called by a service principal profile with appropriate workspace permissions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Linked Report History Snapshot **Slug:** `MICROSOFT_POWER_BI_GET_LINKED_REPORT_HISTORY_SNAPSHOT` Gets requested HistorySnapshot item specified by HistoryId of the LinkedReport specified by Id. Use this action when you need to retrieve a specific history snapshot for a Power BI LinkedReport. History snapshots capture the state of a report at a particular point in time and can be used for auditing, versioning, or recovery purposes. This is a read-only operation that returns snapshot metadata including creation date, snapshot ID, and size information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The key (GUID or path) that uniquely identifies the LinkedReport. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path='/folder1/folder2/item'. If the path contains a single quote, escape it by adding another single quote. | | `historyId` | string | Yes | The Id property of the HistorySnapshot. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Page **Slug:** `MICROSOFT_POWER_BI_GET_PAGE` Returns the specified page within the specified report from the specified workspace. Use this action when you need to retrieve details about a specific page within a Power BI report. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Permissions: This API call can be called by a service principal profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID | | `page_name` | string | Yes | The page name | | `report_id` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pages from Report **Slug:** `MICROSOFT_POWER_BI_GET_PAGES` Returns a list of pages within the specified report from the specified workspace. Use this action when you need to retrieve all pages in a Power BI report to understand the report structure, navigate between pages, or manage report content. This API call can be called by a service principal profile. Required Scope: Report.ReadWrite.All or Report.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `reportId` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Pages from Report in My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_PAGES_IN_MY_WORKSPACE` Returns a list of pages within the specified report from My workspace. Use this action when you need to retrieve all pages in a Power BI report that belongs to your personal workspace. This is useful for understanding the report structure, navigating between pages, or managing report content. Required Scope: Report.ReadWrite.All or Report.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reportId` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Parameters **Slug:** `MICROSOFT_POWER_BI_GET_PARAMETERS` Returns a list of parameters for the specified dataset from **My workspace**. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset, including whether each parameter is required, its data type, and any suggested values. This is useful for auditing dataset configuration, understanding data source connections, or preparing to update parameter values. Required Scope: Dataset.Read #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The unique identifier of the Power BI dataset in My Workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Parameters in Workspace **Slug:** `MICROSOFT_POWER_BI_GET_PARAMETERS_IN_GROUP2` Returns a list of parameters for the specified dataset from the specified workspace. Use this action when you need to retrieve all parameter definitions and their current values for a Power BI dataset within a specific workspace, including whether each parameter is required, its data type, and any suggested values. This is useful for auditing dataset configuration, understanding data source connections, or preparing to update parameter values in a workspace context. This API call can be called by a service principal profile with appropriate workspace permissions. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The unique identifier of the Power BI dataset in the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Query Scale Out Sync Status **Slug:** `MICROSOFT_POWER_BI_GET_QUERY_SCALE_OUT_SYNC_STATUS_2` Returns the query scale-out sync status for the specified dataset from the specified workspace. Use this action when you need to check the synchronization status of read-only replicas for a dataset that supports query scale-out. This includes information about commit versions, active read timestamps, and the current sync status. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Refreshable For Capacity **Slug:** `MICROSOFT_POWER_BI_GET_REFRESHABLE_CAPACITY_2` Returns the specified refreshable for the specified capacity that the user has access to. Use this action when you need to retrieve details about a specific refreshable item (dataset) within a capacity, including refresh history, schedules, and status. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. Required Scope: Capacity.Read.All or Capacity.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports 'capacities' and 'groups'. | | `capacity_id` | string | Yes | The capacity ID | | `refreshable_id` | string | Yes | The refreshable ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get refreshables for all capacities **Slug:** `MICROSOFT_POWER_BI_GET_REFRESHABLES` Returns a list of refreshables for all capacities that the user has access to. Use when you need to retrieve information about datasets and dataflows that have refresh schedules or refresh history across all Power BI capacities. Power BI retains a seven-day refresh history for each dataset, up to a maximum of sixty refreshes. This action is useful for monitoring refresh performance, identifying failed refreshes, and auditing refresh schedules across the organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results. | | `skip` | integer | No | Skips the first n results. Use with top to fetch results beyond the first 1000. | | `expand` | string | No | Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports `capacity` and `group`. | | `filter` | string | No | Returns a subset of results based on OData filter query parameter condition. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Refresh Execution Details In Group **Slug:** `MICROSOFT_POWER_BI_GET_REFRESH_EXECUTION_DETAILS_IN_GROUP` Returns execution details of a refresh operation for the specified dataset from the specified workspace. Use this action when you need to retrieve detailed information about a dataset refresh operation within a workspace, including timing, status, errors, and any retry attempts. This is useful for monitoring refresh operations, troubleshooting failed refreshes, and auditing refresh history. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID. | | `refreshId` | string | Yes | The refresh ID that identifies the specific refresh operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Refresh History for Dataset **Slug:** `MICROSOFT_POWER_BI_GET_REFRESH_HISTORY` Returns the refresh history for the specified dataset from My workspace. Use when you need to retrieve the refresh history of a specific Power BI dataset to monitor refresh performance, identify failed refreshes, or audit refresh operations. Power BI retains between 20-60 available refresh history entries depending on the number of refreshes in the last 3 days. The most recent 60 entries are kept if they are all less than 3 days old. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: OneDrive refresh history isn't returned by this endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | The requested number of entries in the refresh history. If not provided, the default is the last available 60 entries. | | `dataset_id` | string | Yes | The dataset ID of the dataset to get refresh history for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Refresh Schedule **Slug:** `MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE` Returns the refresh schedule for the specified dataset from My workspace. Use when you need to retrieve the current refresh schedule configuration for a dataset, including the days, times, and notification settings. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset_id` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Refresh Schedule In Group 2 **Slug:** `MICROSOFT_POWER_BI_GET_REFRESH_SCHEDULE_IN_GROUP2` Returns the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to retrieve the current refresh schedule configuration for a dataset within a specific Power BI workspace, including the days, times, and notification settings. This action is read-only and idempotent. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API can be called by a service principal profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report from My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_REPORT3` Returns the specified report from My workspace. Use this action when you need to retrieve details about a specific Power BI report from your personal workspace, including its metadata, embed URL, ownership information, and associated dataset. Required Scope: Report.ReadWrite.All or Report.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reportId` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Page From My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_REPORT_PAGE2` Returns the specified page within the specified report from My workspace. Use this action when you need to retrieve details about a specific page within a Power BI report in your personal workspace. This is useful for exploring report structure, getting page metadata, or identifying the order of pages in a report. Required Scope: Report.ReadWrite.All or Report.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page_name` | string | Yes | The page name | | `report_id` | string | Yes | The report ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Reports **Slug:** `MICROSOFT_POWER_BI_GET_REPORTS` Gets an array of Report CatalogItems from Power BI. Use this action when you need to retrieve all reports available in the Power BI service. This is useful for browsing the report catalog, finding specific reports, or auditing available resources. The endpoint supports OData query parameters for filtering, sorting, and pagination. Required Scope: Report.Read.All or Report.ReadWrite.All Note: This endpoint uses the v2.0 Power BI Report Server API path. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Show only the first n items. See OData Paging - Top. | | `skip` | integer | No | Skip the first n items. See OData Paging - Skip. | | `count` | string | No | Include count of items. See OData Count. | | `filter` | string | No | Filter items by property values. See OData Filtering. | | `select` | string | No | Select properties to be returned. See OData Select. | | `order_by` | string | No | Order items by property values. See OData Sorting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Reports From My Workspace **Slug:** `MICROSOFT_POWER_BI_GET_REPORTS3` Returns a list of reports from My workspace. Use this action when you need to retrieve all reports from your personal Power BI workspace. This also returns shared reports and reports from shared apps. This is useful for exploring your personal workspace contents, finding specific report IDs, or managing report resources. Required Scope: Report.ReadWrite.All or Report.Read.All Note: Service principal authentication isn't supported. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resources **Slug:** `MICROSOFT_POWER_BI_GET_RESOURCES` Gets an array of Resource catalog items. Use this action when you need to retrieve all Power BI resources from the catalog. This is useful for exploring available resources, finding specific resource IDs, or managing resource content. Note: This endpoint uses the Power BI REST API (cloud service). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Show only the first n items, see OData Paging - Top | | `skip` | integer | No | Skip the first n items, see OData Paging - Skip | | `count` | boolean | No | Include count of items, see OData Count | | `filter` | string | No | Filter items by property values, see OData Filtering | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Scorecard By ID **Slug:** `MICROSOFT_POWER_BI_GET_SCORECARD_BY_ID` Returns a scorecard with the specified ID. Use this action when you need to retrieve details about a specific Power BI scorecard within a workspace, including its goals, metrics, and configuration. This action supports optional OData expansion for including related data like goals, goal values, aggregations, and notes in the response. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | string | No | Accepts a comma-separated list of data types to expand inline in the response. Supports: goals, goalValues, aggregations, notes | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Scorecards **Slug:** `MICROSOFT_POWER_BI_GET_SCORECARDS` Returns a list of scorecards from a workspace. Use this action when you need to retrieve all scorecards within a Power BI workspace. This is useful for exploring workspace goals, finding specific scorecard IDs, or managing scorecard resources. Required Scope: Dataset.Read.All or Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Returns only the first n results. | | `groupId` | string | Yes | The unique identifier of the workspace (group). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tables in Dataset **Slug:** `MICROSOFT_POWER_BI_GET_TABLES` Returns a list of tables within the specified dataset from My workspace. Use this action when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tables in Dataset within Workspace **Slug:** `MICROSOFT_POWER_BI_GET_TABLES_IN_GROUP` Returns a list of tables within the specified dataset from the specified workspace. Use when you need to retrieve the schema, columns, measures, and other structural metadata of tables within a Power BI dataset in a specific workspace. This is useful for understanding the data model, exploring available fields, or preparing to write DAX expressions. Required Scope: Dataset.ReadWrite.All or Dataset.Read.All Note: This API only supports push datasets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tiles from My Workspace Dashboard **Slug:** `MICROSOFT_POWER_BI_GET_TILES2` Returns a list of tiles within the specified dashboard from My workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard in My workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dashboard_id` | string | Yes | The dashboard ID (UUID) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tiles from Workspace Dashboard **Slug:** `MICROSOFT_POWER_BI_GET_TILES3` Returns a list of tiles within the specified dashboard from the specified workspace. Use this action when you need to retrieve all tiles (visualizations) from a specific dashboard within a Power BI workspace. Supported tiles include datasets and live tiles that contain an entire report page. This is useful for understanding what content exists in a dashboard or for enumerating dashboard elements. Required Scope: Dashboard.Read.All or Dashboard.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace (group) ID | | `dashboard_id` | string | Yes | The dashboard ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace **Slug:** `MICROSOFT_POWER_BI_GET_WORKSPACE` Returns a specified workspace (group). Use this action when you need to retrieve details about a specific Power BI workspace, including its name, capacity configuration, storage settings, and Log Analytics workspace integration. Permissions: This API call can be called by a service principal profile. Required Scope: Workspace.Read.All or Workspace.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Query Scale Out Sync in Workspace **Slug:** `MICROSOFT_POWER_BI_MICROSOFT_POWER_BI_DATASETS_TRIGGER_QUERY_SCALE_OUT_SYNC_IN_GROUP` Triggers a query scale-out sync of read-only replicas for the specified dataset from the specified workspace. Use this action when you need to manually synchronize read-only replicas for a dataset in a specific Power BI workspace. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Power BI Scorecard Goals **Slug:** `MICROSOFT_POWER_BI_MOVE_GOALS` Moves goals within the scorecard. Changes their ranks and parents. Use when you need to reorganize the goal hierarchy in a Power BI scorecard, such as reordering goals within the same parent, moving a goal to a different parent, or repositioning a goal among its siblings. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The unique identifier of the workspace (group) | | `new_next` | object | No | Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals. | | `new_parent` | object | No | Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals. | | `goal_to_move` | object | Yes | The goal to move and its current position validation information | | `new_previous` | object | No | Rank validation information for a Power BI goal. The caller provides validation information to confirm that they know the existing position of the goal within the hierarchy of goals. | | `scorecard_id` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Goal Note **Slug:** `MICROSOFT_POWER_BI_PATCH_GOAL_NOTE` Updates a goal value check-in note by ID. Use this action when you need to update the content of an existing goal check-in note in Power BI goals. This action modifies the note body while preserving other note metadata like timestamps and IDs. This is useful for correcting errors, adding additional context, or updating progress notes on goals. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The note text content to be updated | | `goalId` | string | Yes | The unique identifier of the goal | | `noteId` | string | Yes | The unique identifier of the goal check-in note | | `groupId` | string | Yes | The unique identifier of the workspace | | `timestamp` | string | Yes | The timestamp for the value of the goal (e.g., 2024-05-12T00:00:00Z) | | `scorecardId` | string | Yes | The unique identifier of the scorecard | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Goal Value By ID **Slug:** `MICROSOFT_POWER_BI_PATCH_GOAL_VALUE_BY_ID` Updates a goal value check-in by a UTC date timestamp. Use this action when you need to update the value, status, target, or other properties of a specific goal value check-in within a Power BI scorecard. This allows you to record progress updates for goals at specific timestamps. Requires the Dataset.ReadWrite.All scope. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trend` | integer | No | The goal value trend. | | `value` | number | No | The goal current value. | | `goalId` | string | Yes | The unique identifier of the goal. | | `status` | integer | No | The ID of the goal status. 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed. | | `target` | number | No | The goal target value. | | `groupId` | string | Yes | The unique identifier of the workspace (group). | | `forecast` | number | No | The goal value trend forecast. | | `timestamp` | string | Yes | The UTC timestamp for the value of the goal (e.g., 2026-05-12T00:00:00Z). | | `createdTime` | string | No | The UTC time at creation. | | `scorecardId` | string | Yes | The unique identifier of the scorecard. | | `lastModifiedTime` | string | No | The UTC time at last modification. | | `valueDisplayString` | string | No | The textual representation of the current goal value. | | `targetDisplayString` | string | No | The textual representation of the goal target. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Scorecard By ID **Slug:** `MICROSOFT_POWER_BI_PATCH_SCORECARD_BY_ID` Updates a scorecard by its ID. Use this action when you need to modify properties of an existing Power BI scorecard, such as updating its name, description, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The scorecard name | | `goals` | array | No | The scorecard goals | | `groupId` | string | Yes | The unique identifier of the workspace (group) | | `reportId` | string | No | The ID of the internal report associated with the scorecard | | `datasetId` | string | No | The ID of the dataset associated with the scorecard | | `description` | string | No | The scorecard description | | `permissions` | string ("None" | "Read" | "Write" | "ReadWrite") | No | The scorecard permissions. | | `scorecardId` | string | Yes | The unique identifier of the scorecard | | `columnSettings` | array | No | The display settings for columns on a scorecard | | `provisioningStatus` | string ("Initialized" | "Completed" | "Failed" | "Deprovisioning" | "Deleted") | No | The provisioning status of the scorecard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Push Dataset in Workspace **Slug:** `MICROSOFT_POWER_BI_POST_DATASET_IN_GROUP` Creates a new push dataset in the specified Power BI workspace. Use this action when you need to create a new push dataset in a specific workspace 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the dataset to create. | | `tables` | array | Yes | The list of tables to create in the dataset. | | `group_id` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasources` | array | No | The data sources associated with this dataset. | | `default_mode` | string ("AsAzure" | "AsOnPrem" | "Push" | "Streaming" | "PushStreaming") | No | Dataset mode or type. | | `relationships` | array | No | The relationships between tables in this dataset. | | `default_retention_policy` | string ("None" | "basicFIFO") | No | Default retention policy for the dataset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Grant Dataset User Permissions **Slug:** `MICROSOFT_POWER_BI_POST_DATASET_USER` Grants the specified user's permissions to the specified dataset. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset_id` | string | Yes | The dataset ID. | | `identifier` | string | Yes | Identifier of the user (email address for User principalType, group ID for Group, app ID for App). | | `principal_type` | string ("User" | "Group" | "App") | Yes | The type of principal (User, Group, or App). | | `dataset_user_access_right` | string ("Read" | "ReadReshare" | "ReadExplore" | "ReadReshareExplore") | Yes | The access right to grant to the user for the dataset. Read allows viewing, ReadReshare adds resharing capability, ReadExplore enables explore mode, ReadReshareExplore combines reshare and explore. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Grant Dataset User Permissions In Group **Slug:** `MICROSOFT_POWER_BI_POST_DATASET_USER_IN_GROUP` Grants the specified user's permissions to the specified dataset in a workspace. Use this action when you need to assign access rights to a Power BI dataset for a specific user, group, or app within a workspace context. This is useful for managing dataset permissions and controlling who can access or interact with the dataset. Note: When user permissions to a dataset have been recently updated, the new permissions might not be immediately available. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | | `identifier` | string | Yes | Identifier of the user (email address for User principalType, group ID for Group, app ID for App). | | `principalType` | string ("User" | "Group" | "App") | Yes | The type of principal (User, Group, or App). | | `datasetUserAccessRight` | string ("Read" | "ReadReshare" | "ReadExplore" | "ReadReshareExplore") | Yes | The access right to grant to the user for the dataset. Read allows viewing, ReadReshare adds resharing capability, ReadExplore enables explore mode, ReadReshareExplore combines reshare and explore. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Post Goal **Slug:** `MICROSOFT_POWER_BI_POST_GOAL` Adds a new goal to a Power BI scorecard. Use this action when you need to create a new goal within an existing scorecard to track objectives, KPIs, or other metrics. Goals can be organized in a parent-child hierarchy and support various formatting options for dates and values. Requires the Dataset.ReadWrite.All scope. Note: The goal will be created with default values that may need to be updated via additional API calls for detailed configuration. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The goal name. | | `groupId` | string | Yes | The unique identifier of the workspace (group). | | `parentId` | string | No | Optional. The ID of the parent goal, if defined. | | `startDate` | string | No | Optional. The UTC timestamp for the start date of the goal. The time portion is zero. | | `scorecardId` | string | Yes | The unique identifier of the scorecard. | | `completionDate` | string | No | Optional. The UTC timestamp for the completion date of the goal. The time portion is zero. | | `datesFormatString` | string | No | Optional. The custom format string for dates. | | `valuesFormatString` | string | No | Optional. The custom format string for values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Post Goal Note **Slug:** `MICROSOFT_POWER_BI_POST_GOAL_NOTE` Adds a new note to a goal value check-in for a Power BI scorecard goal. Use this action when you need to add a note or comment to a specific goal value check-in within a Power BI scorecard. This allows you to provide additional context or explanations for goal progress updates. The timestamp parameter identifies the specific goal value check-in to attach the note to. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The note text to be added to the goal value check-in | | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace (group) containing the scorecard | | `timestamp` | string | Yes | The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero. | | `scorecardId` | string | Yes | The unique identifier of the scorecard containing the goal | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Rows to Dataset Table in Workspace **Slug:** `MICROSOFT_POWER_BI_POST_ROWS_IN_GROUP` Adds new data rows to the specified table within the specified dataset from the specified workspace. Use this action when you need to push new data rows into a Power BI push dataset table. This action is idempotent — pushing the same rows multiple times will add duplicate data. The dataset must be a push dataset (Push, Streaming, or PushStreaming mode) with the Add Rows API enabled. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rows` | array | Yes | An array of data rows to push to the dataset table. Each element is a collection of properties represented using key-value format. | | `groupId` | string | Yes | The workspace ID | | `datasetId` | string | Yes | The dataset ID | | `tableName` | string | Yes | The table name within the dataset | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Post Goal Status Rules **Slug:** `MICROSOFT_POWER_BI_POST_STATUS_RULES` Creates or updates status rules of a goal in Power BI. Use this action when you need to define custom status rules that automatically set a goal's status based on conditions such as current value, threshold comparisons, or state values. The defaultOutput is used when no rule conditions are met. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rules` | array | No | Optional. The list of status rules to apply. | | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace | | `scorecardId` | string | Yes | The unique identifier of the scorecard | | `defaultOutput` | integer | Yes | The default status ID when no rule matches. Values: 0=Not started, 1=On track, 2=At risk, 3=Behind, 4=Overdue, 5=Completed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Table Schema **Slug:** `MICROSOFT_POWER_BI_PUT_TABLE` Updates the metadata and schema for the specified table within the specified dataset from My workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The table name (must match the tableName path parameter). | | `source` | array | No | The list of sources for this table (used for streaming datasets). | | `columns` | array | Yes | The list of column definitions for this table. This replaces existing columns. | | `measures` | array | No | The list of measure definitions for this table. | | `is_hidden` | boolean | No | Whether the table is hidden from client tools. | | `dataset_id` | string | Yes | The dataset ID containing the table to update. | | `table_name` | string | Yes | The name of the table to update. | | `description` | string | No | The table description. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Table Schema in Workspace **Slug:** `MICROSOFT_POWER_BI_PUT_TABLE_IN_GROUP` Updates the metadata and schema for the specified table within the specified dataset from the specified workspace. Use this action when you need to modify the schema or metadata of an existing table in a Power BI push dataset within a workspace. This includes updating columns, adding measures, or changing table properties. The table must already exist in the dataset. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The table name (must match the tableName path parameter). | | `source` | array | No | The list of sources for this table (used for streaming datasets). | | `columns` | array | Yes | The list of column definitions for this table. This replaces existing columns. | | `group_id` | string | Yes | The workspace (group) ID containing the dataset. | | `measures` | array | No | The list of measure definitions for this table. | | `is_hidden` | boolean | No | Whether the table is hidden from client tools. | | `dataset_id` | string | Yes | The dataset ID containing the table to update. | | `table_name` | string | Yes | The name of the table to update. | | `description` | string | No | The table description. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rebind Report to Dataset **Slug:** `MICROSOFT_POWER_BI_REBIND_REPORT` Rebinds the specified report from the specified workspace to the specified dataset. Use this action when you need to change which dataset a Power BI report uses. This is useful for migrating reports to different datasets, connecting reports to updated data sources, or consolidating multiple reports under a single dataset. If the target dataset resides in a different workspace than the report, a shared dataset will be automatically created in the report's workspace. Required Scope: Report.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID. The report must belong to this workspace. | | `reportId` | string | Yes | The report ID to rebind. | | `datasetId` | string | Yes | The dataset ID to rebind the report to. If the dataset resides in a different workspace than the report, a shared dataset will be created in the report's workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Dataset Refresh in Workspace **Slug:** `MICROSOFT_POWER_BI_REFRESH_DATASET_IN_GROUP` Triggers a refresh for the specified dataset from the specified workspace. Use this action when you need to manually trigger a dataset refresh in a Power BI workspace. An enhanced refresh is triggered only if a request payload other than notifyOption is set (e.g., when specifying specific tables, commit mode, or timeout). Note: This action is asynchronous - it initiates the refresh and returns immediately. Use GetRefreshHistory or GetRefreshExecutionDetails to monitor the refresh status. Required Scope: Dataset.ReadWrite.All This action is not destructive - it initiates a refresh operation that can be monitored and cancelled if needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that contains the dataset. | | `datasetId` | string | Yes | The dataset ID to refresh. | | `datasetRefreshRequest` | object | No | Power BI dataset refresh request payload. An enhanced refresh is triggered only if a request payload other than notifyOption is set. If only notifyOption is provided, a standard refresh is triggered. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Report Embed Token for Create in Group **Slug:** `MICROSOFT_POWER_BI_REPORTS_GENERATE_TOKEN_CREATE_IN_GROUP` Generates an embed token to allow report creation in the specified workspace based on the specified dataset. Use this action when you need to generate an embed token to create a new Power BI report within a specific workspace. The token is based on a dataset and allows programmatic report creation through the Power BI API. You can configure row-level security (RLS) by providing identities, and customize the token lifetime. Required Scope: Report.ReadWrite.All or Report.Read.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | The workspace ID | | `dataset_id` | string | No | The dataset ID used for report creation. Only applies when you generate an embed token for report creation. | | `identities` | array | No | A list of identities to use for row-level security rules. | | `access_level` | string ("View" | "Edit" | "Create") | Yes | The required access level for embed token generation. | | `allow_save_as` | boolean | No | Whether an embedded report can be saved as a new report. The default value is `false`. Only applies when you generate an embed token for report embedding. | | `lifetime_in_minutes` | integer | No | The maximum lifetime of the token in minutes, starting from the time it was generated. Can be used to shorten the expiration time of a token, but not to extend it. The value must be a positive integer. Zero (0) is equivalent to null and will be ignored, resulting in the default expiration time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Linked Report Cache Options **Slug:** `MICROSOFT_POWER_BI_SET_LINKED_REPORT_CACHE_OPTIONS` Replaces the CacheOption's content for a given LinkedReport using the provided definition. Use this action when you need to configure or update the cache settings for a Power BI linked report. This includes setting the execution type (Live, Cache, or Snapshot) and optionally configuring cache expiration. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Report.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The key (GUID or path) that uniquely identifies the linked report. GUID example: 01234567-89ab-cdef-0123-456789abcdef. Path example: path='/folder1/folder2/item'. If the path contains a single quote, escape it by adding another single quote. | | `cache_options` | object | Yes | The cache options configuration to apply to the linked report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Take Over Dataset **Slug:** `MICROSOFT_POWER_BI_TAKE_OVER_DATASET` Transfers ownership over the specified dataset to the current authorized user. Use this action when you need to take over ownership of a dataset in a Power BI workspace. This is useful when the original owner has left the organization or is unavailable, and another user needs to manage the dataset. This API call can be called by a service principal profile. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that contains the dataset | | `datasetId` | string | Yes | The dataset ID to take over | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Take Over Paginated Report Ownership **Slug:** `MICROSOFT_POWER_BI_TAKE_OVER_REPORT_IN_GROUP` Transfers ownership of the data sources for the specified paginated report (RDL) to the current authorized user. Use this action when you need to take ownership of a paginated report's data sources in a Power BI workspace. This is useful when the previous owner is no longer available or you need administrative control over the report's data connections. This operation affects all data sources associated with the report. Required Scope: Report.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID | | `reportId` | string | Yes | The report ID of the paginated report (RDL) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Trigger Query Scale Out Sync **Slug:** `MICROSOFT_POWER_BI_TRIGGER_QUERY_SCALE_OUT_SYNC` Triggers a query scale-out sync of read-only replicas for the specified dataset from My workspace. Use this action when you need to manually synchronize read-only replicas for a dataset that supports query scale-out. This is typically used for maintenance or to ensure all replicas are synchronized before performing administrative operations. The sync operation ensures that read-only replicas have the latest data from the primary dataset. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dataset **Slug:** `MICROSOFT_POWER_BI_UPDATE_DATASET` Updates the properties for the specified dataset from My workspace. Use this action when you need to modify dataset settings such as query scale-out configuration or storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datasetId` | string | Yes | The dataset ID. | | `targetStorageMode` | string | No | The dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel. | | `queryScaleOutSettings` | object | No | Query scale out settings for the dataset update request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dataset In Workspace **Slug:** `MICROSOFT_POWER_BI_UPDATE_DATASET_IN_GROUP` Updates the properties for the specified dataset from the specified workspace. Use this action when you need to modify dataset settings in a workspace, such as configuring query scale-out settings or changing the storage mode. The user must be the dataset owner to perform this operation. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID. | | `targetStorageMode` | string | No | The dataset storage mode. Values: Abf, PremiumFiles, SmallSemanticModel. | | `queryScaleOutSettings` | object | No | Query scale out settings for the dataset update request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Paginated Report Data Sources **Slug:** `MICROSOFT_POWER_BI_UPDATE_DATASOURCES3` Updates the data sources of the specified paginated report (RDL) from the specified workspace. Use this action when you need to update the connection details (server, database) for one or more data sources in a Power BI paginated report within a specific workspace. This is useful for migrating paginated reports between environments (e.g., from development to production) or updating connection strings without republishing the report. [!IMPORTANT] Both the original data source and the new data source must have the exact same schema. Important notes: - Only supports paginated reports (RDL). - Both the original and new data sources must have the exact same schema. - Changing the data source type is not supported. - Open Database Connectivity (ODBC) data sources are not supported. - The user must be the data source owner. Required scope: Reports.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID. | | `reportId` | string | Yes | The paginated report ID. | | `updateDetails` | array | Yes | The update details for the data sources of the paginated report. Each item specifies the data source name and new connection details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Patch Goal By ID **Slug:** `MICROSOFT_POWER_BI_UPDATE_GOAL_BY_ID` Updates a goal by its ID within a Power BI scorecard. Use this action when you need to modify properties of an existing goal in a Power BI scorecard, such as updating its name, description, dates, permissions, or associated settings. This action requires the Dataset.ReadWrite.All scope. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | The goal ID | | `name` | string | No | The goal name | | `rank` | integer | No | The rank of the goal within the ordered set of sibling goals | | `level` | integer | No | The nested level of the goal in the parent-child hierarchy of scorecard goals | | `goalId` | string | Yes | The unique identifier of the goal | | `groupId` | string | Yes | The unique identifier of the workspace (group) | | `parentId` | string | No | The ID of the parent goal, if defined. | | `startDate` | string | No | The UTC timestamp for the start date of the goal. The time portion of the timestamp is zero. | | `goalValues` | array | No | The list of goal value check-ins | | `notesCount` | integer | No | The number of notes | | `createdTime` | string | No | The UTC time at creation | | `description` | string | No | The goal description | | `permissions` | string ("None" | "View" | "UpdateCurrentValue" | "UpdateTargetValue" | "UpdateNotes" | "UpdateStatus" | "UpdateValues" | "All") | No | The goal permissions. | | `scorecardId` | string | Yes | The unique identifier of the scorecard | | `statusRules` | object | No | A container for JSON definitions of status rules on a Power BI goal. | | `aggregations` | array | No | The list of aggregated properties of the goal | | `completionDate` | string | No | The UTC timestamp for the completion date of the goal. The time portion of the timestamp is zero. | | `hasStatusRules` | boolean | No | Whether the goal has status rules defined | | `lastModifiedTime` | string | No | The UTC time at last modification | | `datesFormatString` | string | No | The format string for dates | | `valuesFormatString` | string | No | The format string for values | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dataset Parameters in Workspace **Slug:** `MICROSOFT_POWER_BI_UPDATE_PARAMETERS_IN_GROUP2` Updates the parameters values for the specified dataset from the specified workspace. Use this action when you need to change one or more parameter values in a Power BI dataset that resides in a specific workspace. This is commonly used after updating underlying data sources or to modify dataset configuration without redeploying. [!NOTE] We recommend using enhanced dataset metadata with this API call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The unique identifier of the Power BI dataset. | | `updateDetails` | array | Yes | A list of dataset parameters to update. At least one parameter update is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Refresh Schedule **Slug:** `MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE` Updates the refresh schedule for the specified dataset from My workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | object | No | The refresh schedule configuration for a dataset. | | `datasetId` | string | Yes | The dataset ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Refresh Schedule In Group **Slug:** `MICROSOFT_POWER_BI_UPDATE_REFRESH_SCHEDULE_IN_GROUP3` Updates the refresh schedule for the specified dataset from the specified workspace. Use this action when you need to configure or modify the automatic refresh schedule for a Power BI dataset within a workspace, such as enabling/disabling scheduled refresh, setting refresh days and times, or configuring failure notifications. A request that disables the refresh schedule should contain no other changes. This action is idempotent. Required Scope: Dataset.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `value` | object | No | The refresh schedule configuration for a dataset in a workspace. | | `groupId` | string | Yes | The workspace ID (group ID) that identifies the workspace. | | `datasetId` | string | Yes | The dataset ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Report Content **Slug:** `MICROSOFT_POWER_BI_UPDATE_REPORT_CONTENT` Updates the content of the specified report from **My workspace** with the content of a specified source report. Use this action when you need to replace the content of a report in My workspace with content from another report. The target report must be in My workspace. The source report can be from My workspace or another workspace (in which case a share is required). This operation overwrites the target report's content while keeping its ID, name, and other properties. Required Scope: Report.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | The report ID in My workspace to update | | `source_type` | string | Yes | The source type. Must be 'ExistingReport' | | `source_report` | object | Yes | The source report to copy content from | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace **Slug:** `MICROSOFT_POWER_BI_UPDATE_WORKSPACE` Updates the properties for the specified workspace. Use this action when you need to modify workspace settings such as renaming the workspace or changing the default dataset storage format. This action can be called by a service principal profile with appropriate permissions. This action is idempotent - calling it multiple times with the same parameters will have the same effect. Required Scope: Workspace.ReadWrite.All #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The workspace name. Include this property to rename the workspace. | | `groupId` | string | Yes | The workspace ID | | `defaultDatasetStorageFormat` | string ("Small" | "Large") | No | Dataset storage format for the workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |