Skip to content

Filters & Data Source Connections


Filter Tools

Filter tools manage data filters applied at page or visual scope.

get_filters

Returns all filters for a given page or visual.

Parameters

Name Type Required Description
session_id string Session id from create_session
parent_type string "page" or "visual"
parent_id string Page id or visual id

Response

{
  "filters": [
    {
      "rowId": 1,
      "filter": {
        "id": null,
        "idColumn": "Sales.Region",
        "function": "OnlySelectedValues",
        "values": ["North", "South"],
        "isGroup": false
      }
    }
  ]
}

get_filter

Returns a single filter by its row ID.

Parameters

Name Type Required Description
session_id string Session id from create_session
filter_id int Filter row ID (integer)

create_filter

Creates a new filter on a page or visual.

Parameters

Name Type Required Description
session_id string Session id from create_session
parent_type string "page" or "visual"
parent_id string Page id or visual id
id_column string Column this filter targets (TableName.ColumnName). Omit for group filters.
function string OnlySelectedValues, ExceptSelectedValues, or Expression
expression string Expression code (for Expression function)
expression_language string Expression language (e.g. "DAX", "MDX", "SQL")
values_json string JSON array of string values (for OnlySelectedValues / ExceptSelectedValues), e.g. ["North","South"]
function_name string Platform-native function name
logical_operator string "AND" or "OR" for group filters
is_group bool Whether this is a logical group (defaults to false)

Response

{
  "status": "Success",
  "filterId": 12
}

delete_filter

Deletes a filter by its row ID.

Parameters

Name Type Required Description
session_id string Session id from create_session
filter_id int Filter row ID

Response

{ "status": "Success" }

Data Source Connection Tools

Data source connections describe the data origins of an asset — databases, APIs, files.

get_data_source_connections

Returns all data source connections for a given asset.

Parameters

Name Type Required Description
session_id string Session id from create_session
asset_id string Asset id from list_assets

Response

{
  "dataSourceConnections": [
    {
      "rowId": 1,
      "externalId": null,
      "name": "Sales DB",
      "type": "SQL Server",
      "parameters": {
        "server": "sql.mycompany.com",
        "database": "SalesDB"
      }
    }
  ]
}

get_data_source_connection

Returns a single data source connection by row ID.

Parameters

Name Type Required Description
session_id string Session id from create_session
asset_id string Asset id
row_id int Data source connection row ID (integer)

Response

Full connection object with rowId, externalId, name, type, and parameters.


create_data_source_connection

Creates a new data source connection for an asset.

Parameters

Name Type Required Description
session_id string Session id from create_session
asset_id string Asset id
type string Connection type (e.g. "MySQL", "Postgres", "Web", "Amazon S3")
name string Friendly name — must be unique within the asset
external_id string Platform-assigned connection identifier
parameters object Key-value connection parameters

Response

{
  "status": "Success",
  "rowId": 3,
  "assetId": "asset-guid",
  "externalId": null,
  "name": "Sales DB",
  "type": "SQL Server",
  "parameters": {
    "server": "sql.mycompany.com",
    "database": "SalesDB"
  }
}