Connectors Reference

Power BI

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

 

Actions:

Name

Summary

GetAlerts ()

Get alerts from Power BI

AddRows (string groupid, string datasetid, string tablename, [Optional]Payload Payload)

Add rows to a dataset

ListGroups ()

 

ListDatasets (string groupid)

 

ListTables (string groupid, string datasetid)

 

GetColumns (string groupid, string datasetid, string tablename)

 

 

Triggers:

Name

Summary

CheckAlertStatus (string alertId)

When a data driven alert is triggered

 

Objects:

Name

Summary

Alert

 

Columns

 

Datasets

 

EvaluatedAlert

 

Groups

 

Payload

 

Tables

 

 

Actions:

GetAlerts

Summary: Get alerts from Power BI

Description: Return a list of alerts for a signed in user.

 

Syntax:

PowerBI.GetAlerts ()

 

Returns:

          Type:array of (Alert)

 

AddRows

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)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupid

string

(Workspace)

The unique identifier of the workspace.

True

ListGroups

datasetid

string

(Dataset)

The unique identifier of the dataset.

True

ListDatasets

tablename

string

(Table)

The name of the table.

True

ListTables

Payload

Payload

 

 

False

 

Returns:

 

ListGroups

Summary:

Description: Get Groups for Power BI.

 

Syntax:

PowerBI.ListGroups ()

 

Returns:

          Type:Groups

 

ListDatasets

Summary:

Description: Get datasets for Power BI group.

 

Syntax:

PowerBI.ListDatasets (string groupid)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupid

string

(Workspace)

The unique identifier of the workspace.

True

ListGroups

 

Returns:

          Type:Datasets

 

ListTables

Summary:

Description: Get tables for Power BI dataset.

 

Syntax:

PowerBI.ListTables (string groupid, string datasetid)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupid

string

(Workspace)

The unique identifier of the workspace.

True

ListGroups

datasetid

string

(Dataset)

The unique identifier of the dataset.

True

ListDatasets

 

Returns:

          Type:Tables

 

GetColumns

Summary:

Description: Get columns for Power BI dataset table.

 

Syntax:

PowerBI.GetColumns (string groupid, string datasetid, string tablename)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupid

string

(Workspace)

The unique identifier of the workspace.

True

ListGroups

datasetid

string

(Dataset)

The unique identifier of the dataset.

True

ListDatasets

tablename

string

(Table)

The name of the table.

True

ListTables

 

Returns:

          Type:Columns

 

Triggers:

Trigger CheckAlertStatus

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)

 

Parameters:

Name

Type

Summary

Required

Related Action

alertId

string

(Alert Id)

The alert id to track.

True

GetAlerts

 

Returns:

          Type:EvaluatedAlert

 


 

Alert

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.


 

Columns

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

Datasets

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

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.

 


 

EvaluatedAlert

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

number

Tile value

The value of the tile.


 

Groups

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

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.

 


 

Payload

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Tables

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Table name

The display name of the table.