Resource API
Email Dashboard Screenshot as Attachment
POST
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
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.
string
This is the token you use to embed your dashboard in your site. You can find
this on the Dashboards page in Explo.
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.
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}.
string
The file type for the screenshot. Must be “image” (for a png) or “pdf” (for a
pdf). By default, this is “image.”
string
Set subject for screenshot email. By default this is set to Requested Data
Export:
{download_file_name} {export_type}.
object
Set variables for your screenshot. These will function the same way as
variables you provide in your embed.
number
Width in pixels for the screenshot. Must be greater than 0
Response
number
Indicates whether the call was successfully initiated. 1 if successful, 0 if not.
string
If an email is not provided, this will be the download url for your
screenshot.