dashboard:filter-changed embed event

Payload

{
  "name": "dashboard:filter-changed",
  "payload": {
    "prev": {
      "filter": "OmniQueryFilter",
      "asJsonUrlSearchParam": "string",
    },
    "next": {
      "filter": "OmniQueryFilter",
      "asJsonUrlSearchParam": "string",
    },
    "action": "string",
    "urlId": "string",
  }
}

Properties

object

The previous state of the filter before the change.

Hide prev properties

filter

OmniQueryFilter

An object representing the previous filter configuration.

asJsonUrlSearchParam

string

The previous filter as a JSON URL search param that can be used in dashboard URLs.

object

The new state of the filter after the change.

Hide next properties

filter

OmniQueryFilter

An object representing the new filter configuration.

asJsonUrlSearchParam

string

The new filter as a JSON URL search param that can be used in dashboard URLs.

action

string

The type of filter change:

added - A new filter was added
removed - An existing filter was removed
updated - An existing filter’s value or configuration changed

urlId

string

The URL identifier for the dashboard where the filter was changed.

Example

{
  "users.id": {
    "filter": {
      "is_negative": false,
      "kind": "EQUALS"
    },
    "asJsonUrlSearchParam": "f--users.id=%7B\"is_inclusive\"%3Afalse%2C\"is_negative\"%3Afalse%2C\"kind\"%3A\"EQUALS\"%2C\"type\"%3A\"number\"%2C\"values\"%3A%5B\"3\"%5D%7D"
  }
}

dashboard:filters embed event

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

⌘I

Getting started

Setup

App customization

Events & interactivity

Admin

dashboard:filter-changed embed event

Payload

Properties

Example

​Payload

​Properties

​Example

Payload

Properties

Example