Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Payload

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

​
Properties

​
prev
object
The previous state of the filter before the change.
​
next
object
The new state of the filter after the change.
​
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"
  }
}