dashboard:filter-change-by-url-parameter embed event

This event can only be processed by dashboards. Sending this event to an iframe that contains a non-dashboard Omni URL will have no effect on the embedded page.

Only filters included in the parameter are affected. Any existing filters that aren’t included will retain their existing values.

{
  "name": "dashboard:filter-change-by-url-parameter",
  "payload": {
    "filterUrlParameter": "string"
  }
}

Properties

filterUrlParameter

string

A filter specification object that defines the filter values to apply. Filter specifications are formatted as follows:

f--<filter_id>={"values":["value1","value2", ...]}

You can retrieve values for this parameter by using Omni in a non-embedded context. Navigate to a dashboard with filters and change the filter values. The URL will change when new filter values are applied - use what’s in the URL as the value for this parameter.

Example

{
  "name": "dashboard:filter-change-by-url-parameter",
  "payload": {
    "filterUrlParameter": "f--order_items.status=%7B"appliedLabels"%3A%7B%7D%2C"values"%3A%5B"Complete"%5D%7D"
  }
}

dashboard:filter-changed embed event

dashboard:tile-download embed event

⌘I

Getting started

Setup

App customization

Events & interactivity

Admin

dashboard:filter-change-by-url-parameter embed event

Properties

Example

​Properties

​Example

Properties

Example