POST
/
api
/
dashboard
/
screenshot
curl --location --request POST 'https://api.explo.co/api/dashboard/screenshot' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "provided_id": "123",
    "dashboard_embed_id": "abc123",
    "email": "[email protected]",
    "download_file_name": "your_dashboard_screenshot",
    "export_type": "image",
    "subject": "Requested Data Export: your_dashboard_screenshot image",
    "variables": {"example_var": 123}
}'

{
  "success": 1
}

This endpoint takes a screenshot of the dashboard and emails it as an attachment. This endpoint is rate limited based on the corresponding docs here.

This API will send the most recent version or draft of this dashboard.

​
Body

​
provided_id
string

This is your id for your customer that you’d like to screenshot for. This controls what data the dashboard loads with in the screenshot.

​
dashboard_embed_id
string

This is the token you use to embed your dashboard in your site. You can find this on the Dashboards page in Explo.

​
email
string

The email you’d like this screenshot to be send to. If this is not provided, then a short-lived download link to your screenshot will be returned instead.

​
download_file_name
string

The name you’d like the file to be called in the download. By default, this is set to dashboard_screenshot_download.{png | pdf}.

​
export_type
string

The file type for the screenshot. Must be “image” (for a png) or “pdf” (for a pdf). By default, this is “image.”

​
subject
string

Set subject for screenshot email. By default this is set to Requested Data Export: {download_file_name} {export_type}.

​
variables
object

Set variables for your screenshot. These will function the same way as variables you provide in your embed.

​
width
number

Width in pixels for the screenshot. Must be greater than 0

​
Response

​
success
number

Indicates whether the call was successfully initiated. 1 if successful, 0 if not.

​
url
string

If an email is not provided, this will be the download url for your screenshot.

curl --location --request POST 'https://api.explo.co/api/dashboard/screenshot' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "provided_id": "123",
    "dashboard_embed_id": "abc123",
    "email": "[email protected]",
    "download_file_name": "your_dashboard_screenshot",
    "export_type": "image",
    "subject": "Requested Data Export: your_dashboard_screenshot image",
    "variables": {"example_var": 123}
}'

{
  "success": 1
}