dashboard:download embed event

Payload

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

Properties

userId

string

ID of the user who downloaded the dashboard.

dashboard

object

Information about the dashboard being downloaded.

Hide dashboard properties

filters

object

Filters applied to the dashboard, keyed by filter name.

Hide filters properties

filter

Filter

An object representing the filter.

asJsonUrlSearchParam

string

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

href

string

Full URL of the dashboard.

urlId

string

ID of the dashboard used in the URL.

path

string

Path to the dashboard.

title

string

Title of the dashboard.

format

string

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

appearance:mode embed event

dashboard:filters embed event

⌘I

Getting started

Setup

App customization

Events & interactivity

Admin

dashboard:download embed event

Payload

Properties

​Payload

​Properties

Payload

Properties