Dashboards can have filters in the top action bar.
You can set up filters only in advanced mode using the available_filters property of your .
The user can select a value and all the queries in the dashboard adapt to the selected value.
JSON representation
{
// Using technical names of compartments, segments or channels
// will result in IDs being automatically replaced by names in the UI
"technical_name": String,
"title": String,
"values_retrieve_method": 'Query', // Only available value at the moment
// OTQL query to retrieve list of selectable values
// Use a query string, not the ID of a query
"values_query": String,
// How to adapt queries in the dashboard to the selected value(s)
"query_fragments": [QueryFragment],
"multi_select": Boolean, // If the user can select multiple values
}
A query fragment tells the dashboard how to adapt each query to the value(s) selected by the user.
JSON representation
{
// Any available data source such as 'activities_analytics' or 'OTQL'
"type": String,
// Only for OTQL type, chooses which queries should be transformed
// Select 'ActivityEvent' to transform queries FROM ActivityEvent
"starting_object_type": String,
// The query part to add
"fragment": String,
}
Here is a sample with a filter that enables the selection of compartments and an other for channels
