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

> Emitted by Omni when a user downloads an embedded dashboard.

## Payload

```json theme={null}
{
  "userId": "string",
  "dashboard": {
    "filters": {
      "filterName": {
        "filter": "filterObject",
        "asJsonUrlSearchParam": "string"
      }
    },
    "href": "string",
    "urlId": "string",
    "path": "string",
    "title": "string"
  },
  "format": "string"
}
```

## Properties

<ParamField path="userId" type="string">
  ID of the user who downloaded the dashboard.
</ParamField>

<ParamField path="dashboard" type="object">
  Information about the dashboard being downloaded.

  <Expandable title="dashboard properties" defaultOpen="true">
    <ParamField path="filters" type="object">
      Filters applied to the dashboard, keyed by filter name.

      <Expandable title="filters properties" defaultOpen="true">
        <ParamField path="filter" type="Filter">
          An object representing the filter.
        </ParamField>

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

    <ParamField path="href" type="string">
      Full URL of the dashboard.
    </ParamField>

    <ParamField path="urlId" type="string">
      ID of the dashboard used in the URL.
    </ParamField>

    <ParamField path="path" type="string">
      Path to the dashboard.
    </ParamField>

    <ParamField path="title" type="string">
      Title of the dashboard.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="format" type="string">
  Download format. One of `pdf`, `csv`, or `xlsx`.
</ParamField>