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, such as an app, will have no effect on the embedded page.

Triggers the change of a filter value on an embedded dashboard. Only filters included in the parameter are affected; any existing filters that aren’t included will retain their existing values. This event and dashboard:set-filters are synonyms. They take the same payload and Omni handles them the same way.

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

When to send this event

Send this event after Omni emits page:ready or dashboard:ready. To apply filters each time a dashboard loads, send this event in response to dashboard:ready. If the dashboard isn’t ready when the event arrives, Omni keeps the event and applies it when the dashboard is ready:

If you send more than one event, Omni applies the events in the order that you sent them. If two events set the same filter, the later event wins.
If you send a navigate event, Omni discards the filters that wait for the page the user leaves.
If you send this event after a navigate event, Omni applies the filter to the dashboard where the navigation arrives.

Properties

string

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

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

Retrieve values for this parameter by using Omni in a non-embedded context. Navigate to a dashboard with filters and change the filter values, which changes the URL. Use what’s in the URL as the value for this parameter.

When to send this event

If you send more than one event, Omni applies the events in the order that you sent them. If two events set the same filter, the later event wins.
If you send a navigate event, Omni discards the filters that wait for the page the user leaves.
If you send this event after a navigate event, Omni applies the filter to the dashboard where the navigation arrives.

Dashboard sorts

If the filterUrlParameter changes or removes a value for a control, Omni also updates any dashboard sorts tied to the field the control changed, the same way it does when a viewer changes the control in the dashboard itself. To set the sorts yourself instead, include a dashboard-sorts value in the same message.

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"
  }
}

Getting started

Setup

App customization

Events & interactivity

Admin

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

When to send this event

Properties

When to send this event

Dashboard sorts

Example

​When to send this event

​Properties

​When to send this event

​Dashboard sorts

​Example

When to send this event

Properties

When to send this event

Dashboard sorts

Example