Dashboard API
Email a Dashboard Screenshot
Dashboard API
Email a Dashboard Screenshot
GET
/api/dashboard/screenshot
Explo-Authorization*
curl --request GET \
--url https://api.explo.co/api/dashboard/screenshot \
--header 'Explo-Authorization: <explo-authorization>'Body
customer_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.
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..
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.”
Response
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.
curl --location --request POST 'https://api.explo.co/api/dashboard/screenshot' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"customer_id": "123",
"dashboard_embed_id": "abc123",
"email": "customer@site.com",
"download_file_name": "your_dashboard_screnshot",
"export_type": "image"
}'
{
"success": 1
}
curl --location --request POST 'https://api.explo.co/api/dashboard/screenshot' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"customer_id": "123",
"dashboard_embed_id": "abc123",
"email": "customer@site.com",
"download_file_name": "your_dashboard_screnshot",
"export_type": "image"
}'
{
"success": 1
}