Dashboard API
Email a Dashboard Report
POST
/
api
/
dashboard
/
report
Authorization
Body
curl --location --request POST 'https://api.explo.co/api/dashboard/report' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"provided_id": "123",
"dashboard_embed_id": "abc123",
"email": "[email protected]",
"subject": "Dashboard Email Report",
"variables": {"example_var": 123}
}'
{
"success": 1
}
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.
subject
string
Set subject for report email. By default this set to Dashboard Email Report.
variables
object
Set variables for your report. These will function the same way as variables you provide in your embed.
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/report' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"provided_id": "123",
"dashboard_embed_id": "abc123",
"email": "[email protected]",
"subject": "Dashboard Email Report",
"variables": {"example_var": 123}
}'
{
"success": 1
}