Skip to main content

Overview

Microsoft Power BI REST API integration for datasets, reports, and workspaces. Through Langdock’s integration, you can access and manage Power BI directly from your conversations.
Authentication: OAuth Category: Productivity & Collaboration Availability: All workspace plans

Available Actions

List workspaces

power_bi.list_workspaces
List workspaces (groups) the user has access to. Requires Confirmation: No Parameters: None Output: Returns the operation result

List datasets

power_bi.list_datasets
List datasets in My Workspace or a specified workspace. Requires Confirmation: No Parameters:
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted, lists datasets from My Workspace.
Output: Returns the operation result

List dataset tables (Push API only)

power_bi.list_dataset_tables
Lists tables for a push dataset to discover exact table and column names. Only works for Push API datasets. For Import, DirectQuery, or Composite datasets, use ‘Get dataset schema’ instead. Requires Confirmation: No Parameters:
  • datasetId (TEXT, Required): Required: The Power BI Push API dataset. Accepts a Push API URL (from ‘API Info’ dialog), dataset name, or dataset ID (GUID). Push API URLs look like: https://api.powerbi.com/beta/…/datasets/\{id\}/rows. Note: Push API URLs don’t include workspace - provide it separately if needed.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). Required if dataset is not in My Workspace and you’re using a Push API URL (since Push API URLs don’t include workspace info). If omitted, uses My Workspace.
Output: Returns the operation result

Execute query

power_bi.execute_dax_query
Run DAX queries, DMVs, MDX queries, or INFO DAX functions against a Power BI dataset. Results with more than 50 rows are returned as a CSV file to preserve full data for analysis. DAX queries on standard datasets use the Execute Queries API. Live connection/Azure Analysis Services datasets, DMVs, MDX queries, and INFO DAX functions use XMLA endpoint. Requires Confirmation: Yes Parameters:
  • datasetId (TEXT, Required): Required: The Power BI dataset to query. Accepts a dataset URL, dataset name, or dataset ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • query (MULTI_LINE_TEXT, Required): Query text. Supports DAX queries (EVALUATE), DMVs (SYSTEM),MDXqueries(SELECTONCOLUMNS/ROWS),andINFODAXfunctions.Example:EVALUATESUMMARIZECOLUMNS(...)orSELECTFROMSYSTEM), MDX queries (SELECT ON COLUMNS/ROWS), and INFO DAX functions. Example: EVALUATE SUMMARIZECOLUMNS(...) or SELECT * FROM SYSTEM.DISCOVER_SESSIONS.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

List reports

power_bi.list_reports
List reports in a workspace or in My Workspace. Requires Confirmation: No Parameters:
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted, lists reports from My Workspace.
Output: Returns the operation result

List report pages

power_bi.list_report_pages
List pages for a report. Requires Confirmation: No Parameters:
  • reportId (TEXT, Required): Required: The Power BI report. Accepts a report URL, report name, or report ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a report URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

List dashboards

power_bi.list_dashboards
List dashboards in a workspace or in My Workspace. Requires Confirmation: No Parameters:
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted, lists dashboards from My Workspace.
Output: Returns the operation result

List dashboard tiles

power_bi.list_dashboard_tiles
List tiles on a dashboard. Requires Confirmation: No Parameters:
  • dashboardId (TEXT, Required): Required: The Power BI dashboard. Accepts a dashboard URL, dashboard name, or dashboard ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dashboard URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Export report to file (initiate)

power_bi.export_report_to_file_initiate
Initiates a Power BI report export job. Returns export ID for use with fetch action. Requires Confirmation: Yes Parameters:
  • reportId (TEXT, Required): Required: The report ID (GUID).
  • format (SELECT, Required): Select output format. XLSX is only supported for paginated reports.
  • groupId (TEXT, Optional): Optional: Workspace (group) ID that contains the report. If omitted, exports from My Workspace.
Output: Returns the operation result

Export paginated report (initiate)

power_bi.export_paginated_report_initiate
Initiates a Power BI paginated report export job. Supports more formats than regular reports including XLSX, CSV, DOCX, XML. Returns export ID for use with fetch action. Requires Confirmation: Yes Parameters:
  • reportId (TEXT, Required): Required: The paginated report ID (GUID).
  • format (SELECT, Required): Select output format. Paginated reports support many formats.
  • groupId (TEXT, Optional): Optional: Workspace (group) ID that contains the report. If omitted, exports from My Workspace.
  • reportParameters (OBJECT, Optional): Optional: Parameters to pass to the report as key-value pairs (JSON object).
  • csvDelimiter (TEXT, Optional): Optional: Delimiter for CSV export (default is comma).
  • csvEncoding (SELECT, Optional): Optional: Encoding for CSV export.
  • imageFormat (SELECT, Optional): Optional: When format is IMAGE, specify the image type.
Output: Returns the operation result

Export report to file (fetch)

power_bi.export_report_to_file_fetch
Fetches a Power BI report export (regular or paginated) by checking status and downloading the file if ready. Requires Confirmation: No Parameters:
  • reportId (TEXT, Required): Required: The report ID (GUID).
  • exportId (TEXT, Required): Required: The export ID returned from the initiate action.
  • groupId (TEXT, Optional): Optional: Workspace (group) ID that contains the report. If omitted, fetches from My Workspace.
Output: Returns the operation result

Get dataset details

power_bi.get_dataset_details
Gets detailed information about a specific Power BI dataset. Requires Confirmation: No Parameters:
  • datasetId (TEXT, Required): Required: The Power BI dataset. Accepts a dataset URL, dataset name, or dataset ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get report details

power_bi.get_report_details
Gets detailed information about a specific Power BI report. Requires Confirmation: No Parameters:
  • reportId (TEXT, Required): Required: The Power BI report. Accepts a report URL, report name, or report ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a report URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get dashboard details

power_bi.get_dashboard_details
Gets detailed information about a specific Power BI dashboard. Requires Confirmation: No Parameters:
  • dashboardId (TEXT, Required): Required: The Power BI dashboard. Accepts a dashboard URL, dashboard name, or dashboard ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dashboard URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get tile details

power_bi.get_tile_details
Gets detailed information about a specific Power BI dashboard tile. Requires Confirmation: No Parameters:
  • dashboardId (TEXT, Required): Required: The Power BI dashboard containing the tile. Accepts a dashboard URL, dashboard name, or dashboard ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • tileId (TEXT, Required): Required: The tile ID (GUID).
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dashboard URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get table sample

power_bi.get_table_sample
Gets a sample of data from a specific table in a Power BI dataset. Requires Confirmation: No Parameters:
  • datasetId (TEXT, Required): Required: The Power BI dataset containing the table. Accepts a dataset URL, dataset name, or dataset ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • tableName (TEXT, Required): Required: The name of the table to sample.
  • sampleSize (TEXT, Optional): Optional: Number of rows to sample (default: 100).
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get table count

power_bi.get_table_count
Gets the row count of a specific table in a Power BI dataset. Requires Confirmation: No Parameters:
  • datasetId (TEXT, Required): Required: The Power BI dataset containing the table. Accepts a dataset URL, dataset name, or dataset ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • tableName (TEXT, Required): Required: The name of the table to count.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Search reports

power_bi.search_reports
Searches for Power BI reports by name or description. Requires Confirmation: No Parameters:
  • searchTerm (TEXT, Required): Required: The term to search for in report names and descriptions.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted, searches My Workspace.
Output: Returns the operation result

Search datasets

power_bi.search_datasets
Searches for Power BI datasets by name. Requires Confirmation: No Parameters:
  • searchTerm (TEXT, Required): Required: The term to search for in dataset names.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted, searches My Workspace.
Output: Returns the operation result

Get dataset dependencies

power_bi.get_dataset_dependencies
Gets reports and dashboards that use a specific Power BI dataset. Requires Confirmation: No Parameters:
  • datasetId (TEXT, Required): Required: The Power BI dataset. Accepts a dataset URL, dataset name, or dataset ID (GUID). If a URL is provided, the workspace is automatically extracted.
  • groupId (TEXT, Optional): Optional: Power BI workspace. Accepts a workspace URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL.
Output: Returns the operation result

Get dataset schema

power_bi.get_dataset_schema
Gets full schema metadata (tables, columns, measures, relationships) from a Power BI dataset using the XMLA endpoint. Requires Premium Per User (PPU), Premium capacity, or Fabric capacity with XMLA endpoint enabled. Requires Confirmation: No Parameters:
  • datasetName (TEXT, Required): Required: The dataset to query. Accepts a Power BI dataset URL, dataset name, or dataset ID (GUID). If a dataset URL is provided, the workspace is automatically extracted. The workspace must be on Premium/PPU/Fabric capacity with XMLA endpoint enabled.
  • groupId (TEXT, Optional): Optional: The workspace containing the dataset. Accepts a Power BI URL, workspace name, or workspace ID (GUID). If omitted and a dataset URL is provided, the workspace is extracted from the URL. Otherwise uses your personal workspace (My Workspace).
Output: Returns the operation result