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

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.omni.co/feedback

```json
{
  "path": "/embed/events/dashboard-filter-changed",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# dashboard:filter-changed embed event

> 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

<ParamField path="prev" type="object">
  The previous state of the filter before the change.

  <Expandable title="prev properties" defaultOpen="true">
    <ParamField path="filter" type="OmniQueryFilter">
      An object representing the previous filter configuration.
    </ParamField>

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

<ParamField path="next" type="object">
  The new state of the filter after the change.

  <Expandable title="next properties" defaultOpen="true">
    <ParamField path="filter" type="OmniQueryFilter">
      An object representing the new filter configuration.
    </ParamField>

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

<ParamField path="action" type="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
</ParamField>

<ParamField path="urlId" type="string">
  The URL identifier for the dashboard where the filter was changed.
</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"
  }
}
```