dashboard:filters embed event

Emitted by Omni when a user applies a filter to an embedded document.

Payload

{
  "<filterName>": {
    "filter": {
      "is_negative": false,
      "kind": "EQUALS"
    },
    "asJsonUrlSearchParam": "string"
  }
}

Properties

object

Filter object keyed by the filter name (e.g., users.id).

Hide filter properties

object

An object representing the filter configuration. Contains properties like is_negative, kind, and other filter-specific properties.

string

Filter as a JSON URL search param that can be used in dashboard URLs.

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

Getting started

Setup

App customization

Events & interactivity

Admin

dashboard:filters embed event

Payload

Properties

Example

​Payload

​Properties

​Example

Payload

Properties

Example