> ## 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.

# dashboard:filters embed event

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

## Payload

```json theme={null}
{
  "<filterName>": {
    "filter": {
      "is_negative": false,
      "kind": "EQUALS"
    },
    "asJsonUrlSearchParam": "string"
  }
}
```

## Properties

<ParamField path="filterName" type="object">
  Filter object keyed by the filter name (e.g., `users.id`).

  <Expandable title="filter properties" defaultOpen="true">
    <ParamField path="filter" type="object">
      An object representing the filter configuration. Contains properties like `is_negative`, `kind`, and other filter-specific properties.
    </ParamField>

    <ParamField path="asJsonUrlSearchParam" type="string">
      Filter as a JSON URL search param that can be used in dashboard URLs.
    </ParamField>
  </Expandable>
</ParamField>

## Example

```json wrap theme={null}
{
  "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"
  }
}
```