> ## 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:filter-changed embed event

> Emitted by Omni when a user adds, removes, or updates a filter on an embedded document.

Emitted by Omni when a user adds, removes, or updates a filter on an embedded document.

## Payload

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

**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. A viewer-added dynamic filter uses a `df--` prefix instead of `f--`. Refer to [`dashboard:filters`](https://docs.omni.co/embed/events/dashboard-filters#properties) for more information.

**next** `object`

The new state of the filter after the change.

**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. A viewer-added dynamic filter uses a `df--` prefix instead of `f--`. Refer to [`dashboard:filters`](https://docs.omni.co/embed/events/dashboard-filters#properties) for more information.

**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

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