dashboard:download embed event

Emitted by Omni when a user downloads an embedded dashboard.

Payload

{
  "userId": "string",
  "dashboard": {
    "filters": {
      "filterName": {
        "filter": "filterObject",
        "asJsonUrlSearchParam": "string"
      }
    },
    "href": "string",
    "urlId": "string",
    "path": "string",
    "title": "string"
  },
  "format": "string"
}

Properties

string

ID of the user who downloaded the dashboard.

object

Information about the dashboard being downloaded.

Hide dashboard properties

object

Filters applied to the dashboard, keyed by filter name.

Hide filters properties

Filter

An object representing the filter.

string

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

string

Full URL of the dashboard.

string

ID of the dashboard used in the URL.

string

Path to the dashboard.

string

Title of the dashboard.

string

Download format. One of pdf, csv, or xlsx.

Getting started

Setup

App customization

Events & interactivity

Admin

dashboard:download embed event

Payload

Properties

​Payload

​Properties

Payload

Properties