Connectors Reference
Power BI is a suite of business analytics tools to analyze data and share insights. Connect to get easy access to the data in your Power BI dashboards, reports and datasets.
|
Status: Preview |
Tier: Standard |
Version: v1 |
|
Name |
Summary |
|
Get alerts from Power BI |
|
|
Add rows to a dataset |
|
|
|
|
|
|
|
|
ListTables (string groupid, string datasetid, [internal][Optional]string pbi_source) |
|
|
|
|
|
When a power BI visual button is clicked |
|
|
Get PowerBi Button Clicked hybrid trigger output |
|
|
RefreshDataset (string groupid, string datasetid, [internal][Optional]string pbi_source) |
Refresh a dataset |
|
Export To File for Power BI Reports |
|
|
Export To File for Paginated Reports |
|
|
ExportStatus (string groupid, string reportid, string exportid) |
Check Export Status |
|
Check Export Status for My Workspace |
|
|
GetExportFile (string groupid, string reportid, string exportid) |
Get Export File |
|
Get Export File for MyWorkspace |
|
|
GetReportsInGroup (string groupid, [internal][Optional]string reportType) |
Get Reports in Group |
|
Name |
Summary |
|
CheckAlertStatus (string alertId, [internal][Optional]string pbi_source) |
When a data driven alert is triggered |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get alerts from Power BI
Description: Return a list of alerts for a signed in user.
Syntax:
PowerBI.GetAlerts ([internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:array of (Alert)
Summary: Add rows to a dataset
Description: Use Power BI REST API to add rows to a dataset.
Syntax:
PowerBI.AddRows (string groupid, string datasetid, string tablename, [Optional]Payload Payload, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
datasetid |
string (Dataset) |
The unique identifier of the dataset. |
True |
|
|
tablename |
string (Table) |
The name of the table. |
True |
|
|
Payload |
|
|
False |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Summary:
Description: Get Groups for Power BI.
Syntax:
PowerBI.ListGroups ([internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:Groups
Summary:
Description: Get datasets for Power BI group.
Syntax:
PowerBI.ListDatasets (string groupid, [internal][Optional]boolean refreshDatasetsFilter, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
refreshDatasetsFilter |
boolean
|
Filter out streaming datasets |
False |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:Datasets
Summary:
Description: Get tables for Power BI dataset.
Syntax:
PowerBI.ListTables (string groupid, string datasetid, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
datasetid |
string (Dataset) |
The unique identifier of the dataset. |
True |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:Tables
Summary:
Description: Get columns for Power BI dataset table.
Syntax:
PowerBI.GetColumns (string groupid, string datasetid, string tablename, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
datasetid |
string (Dataset) |
The unique identifier of the dataset. |
True |
|
|
tablename |
string (Table) |
The name of the table. |
True |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:Columns
Summary: When a power BI visual button is clicked
Description: For internal use with the visual button hybrid trigger.
Syntax:
PowerBI.PowerBiButtonClicked ([internal][Optional]string inputsPowerBiData, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputsPowerBiData |
string (Input data from Power BI) |
|
False |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:PowerBiButtonClickedResponse
Summary: Get PowerBi Button Clicked hybrid trigger output
Description: Get the schema information for the PowerBi Button Clicked hybrid trigger output.
Syntax:
PowerBI.GetPowerBiButtonClickedOutputs (string body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
string (inputsPowerBiData) |
|
True |
Returns:
Type:PowerBiButtonClickedOutputs
Description: Tokens coming from Power Bi input data
Summary: Refresh a dataset
Description: Use Power BI REST API to refresh a powerbi dataset.
Syntax:
PowerBI.RefreshDataset (string groupid, string datasetid, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
datasetid |
string (Dataset) |
The unique identifier of the dataset. |
True |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Summary: Export To File for Power BI Reports
Description: Use Power BI Rest API to inititate export for Power BI reports
Syntax:
PowerBI.InitiateExportToFileForPbiReports (string groupid, string reportid, [Optional]ExportPayloadPowerBIReport ExportPayloadPowerBIReport)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
reportid |
string (Report) |
The unique identifier of a pbi report. |
True |
|
|
ExportPayloadPowerBIReport |
|
|
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Export To File for Paginated Reports
Description: Use Power BI Rest API to inititate export for paginated reports
Syntax:
PowerBI.InitiateExportToFileForPaginatedReports (string groupid, string reportid, [Optional]ExportPayloadPaginatedReport ExportPayloadPaginatedReport)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
reportid |
string (Report) |
The unique identifier of a paginated report. |
True |
|
|
ExportPayloadPaginatedReport |
|
|
False |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Check Export Status
Description:
Syntax:
PowerBI.ExportStatus (string groupid, string reportid, string exportid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
reportid |
string (Report ID) |
The unique identifier of a report. |
True |
|
|
exportid |
string (Export ID) |
The export id |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Check Export Status for My Workspace
Description:
Syntax:
PowerBI.MyWSExportStatus (string reportid, string exportid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
reportid |
string (Report ID) |
The my workspace report id |
True |
|
|
exportid |
string (Export ID) |
The export id |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Get Export File
Description:
Syntax:
PowerBI.GetExportFile (string groupid, string reportid, string exportid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
reportid |
string (Report ID) |
The unique identifier of a report. |
True |
|
|
exportid |
string (Export ID) |
The export id |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Get Export File for MyWorkspace
Description:
Syntax:
PowerBI.MyWSGetExportFile (string reportid, string exportid)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
reportid |
string (Report ID) |
The my workspace report id |
True |
|
|
exportid |
string (Export ID) |
The export id |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Get Reports in Group
Description: Returns a list of reports from the specified workspace.
Syntax:
PowerBI.GetReportsInGroup (string groupid, [internal][Optional]string reportType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupid |
string (Workspace) |
The unique identifier of the workspace. |
True |
|
|
reportType |
string
|
Type of report |
False |
Returns:
Type:Reports
Description: Odata response wrapper for a Power BI report collection
Summary: When a data driven alert is triggered
Description: Return the details of the specified data driven alert from Power BI when the alert triggered.
Syntax:
PowerBI.CheckAlertStatus (string alertId, [internal][Optional]string pbi_source)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
alertId |
string (Alert Id) |
The alert id to track. |
True |
|
|
pbi_source |
string (pbi_source) |
Source of the call for tracing |
False |
Returns:
Type:EvaluatedAlert
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
alertId |
string Alert ID |
The ID of the alert. |
|
alertTitle |
string Alert title |
The title of the alert. |
|
groupId |
string Group ID |
The ID of the group. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
schema |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Dataset ID |
The ID of the dataset. |
|
name |
string Dataset name |
The display name of the dataset. |
|
addRowsAPIEnabled |
boolean Add Rows API Enabled |
A boolean value (true, false) determining whether or not this dataset supports programmatic adding of rows. |
Summary:
Description: Defines the user identity and roles, for more details see this [article](https://docs.microsoft.com/power-bi/developer/embedded-row-level-security)
Properties:
|
Name |
Type |
Summary |
|
username |
string
|
The effective username reflected by a token for applying RLS rules (For OnPrem model, username can be composed of alpha-numerical characters or any of the following characters '.', '-', '_', '!', '#', '^', '~', '\\', '@', also username cannot contain spaces. For Cloud model, username can be composed of all ASCII characters. username must be up to 256 characters) |
|
datasets |
array of (string)
|
An array of datasets for which this identity applies |
|
roles |
array of (string)
|
An array of RLS roles reflected by a token when applying RLS rules (identity can contain up to 50 roles, role can be composed of any character besides ',' and must be up to 50 characters) |
|
customData |
string
|
The value of customdata to be used for applying RLS rules. Only supported for live connections to Azure Analysis Services. |
|
identityBlob |
|
A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure |
|
reports |
array of (string)
|
An array of reports for which this identity applies, Only supported for paginated reports |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
alertTitle |
string Alert title |
The title of the alert. |
|
alertThreshold |
number Alert threshold |
The threshold at which the alert is triggered. |
|
isAlertTriggered |
boolean Is alert triggered |
A boolean value (true, false) determining Whether or not the alert was triggered. |
|
tileUrl |
string Tile URL |
URL linking to the dashboard tile where the alert is set up. |
|
tileValue |
Tile value |
The value of the tile. |
Summary: Tile value
Description: The value of the tile.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A filter to be applied during the export operation
Properties:
|
Name |
Type |
Summary |
|
filter |
string
|
The filter to apply |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
format |
string
|
format in which the Paginated report needs to be exported in Values: [PDF, CSV, DOCX, IMAGE, MHTML, PPTX, XLSX, XML] |
|
paginatedReportConfiguration |
|
paginatedReportConfiguration |
Summary:
Description: paginatedReportConfiguration
Properties:
|
Name |
Type |
Summary |
|
identities |
array of (EffectiveIdentity)
|
A single identity to use when exporting a report. Required when a report uses a Power BI dataset or an Azure AS datasource. |
|
formatSettings |
|
Dictionary of format settings. The keys are the device info property names for the requested file format. |
|
parameterValues |
array of (ParameterValuesItem)
|
List of report parameters |
Summary:
Description: Dictionary of format settings. The keys are the device info property names for the requested file format.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The report parameter name |
|
value |
string
|
The report parameter value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
format |
string
|
format in which the Power BI report needs to be exported in Values: [PDF, PPTX, PNG] |
|
PowerBIReportExportConfiguration |
PowerBIReportExportConfiguration
|
Power BI report Export to file configuration |
Summary:
Description: Power BI report Export to file configuration
Properties:
|
Name |
Type |
Summary |
|
settings |
|
Export to file request settings |
|
defaultBookmark |
|
The bookmark to apply on a single page. Provide name or state, but not both. |
|
reportLevelFilters |
array of (ExportFilter)
|
List of report level filters to apply. Currently only one filter can be provided |
|
pages |
array of (ExportReportPage)
|
List of pages to export and their properties |
|
identities |
array of (EffectiveIdentity)
|
List of identities to use for RLS rules |
Summary:
Description: A single page configuration for the export request
Properties:
|
Name |
Type |
Summary |
|
pageName |
string
|
The page name |
|
visualName |
string
|
(Optional) Visual name to be exported |
|
bookmark |
|
The bookmark to apply on a single page. Provide name or state, but not both. |
Summary:
Description: Export to file request settings
Properties:
|
Name |
Type |
Summary |
|
locale |
string
|
The locale to apply |
|
includeHiddenPages |
boolean
|
A flag indicating whether to include hidden pages when exporting the entire report (when passing specific pages this property will be ignored). If not provided, the default behavior is to exclude hidden pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Group ID |
The ID of the group. |
|
name |
string Group name |
The display name of the group. |
Summary:
Description: A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure
Properties:
|
Name |
Type |
Summary |
|
value |
string
|
OAuth2 access token for SQL Azure |
Summary:
Description: The bookmark to apply on a single page. Provide name or state, but not both.
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
The bookmark name |
|
state |
string
|
The bookmark state |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Tokens coming from Power Bi input data
Properties:
|
Name |
Type |
Summary |
|
PowerBiInputs |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Odata response wrapper for a Power BI report collection
Properties:
|
Name |
Type |
Summary |
|
odata.context |
string
|
OData context |
|
value |
array of (ValueItem)
|
The report collection |
Summary:
Description: A Power BI report
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
The report id |
|
name |
string
|
The report name |
|
webUrl |
string
|
The report web url |
|
embedUrl |
string
|
The report embed url |
|
datasetId |
string
|
The dataset id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Table name |
The display name of the table. |