POST
/
api
/
dashboard
/
report
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": {
        "url": "https://google.com",
        "date_range":{"startDate": "2024-04-09","endDate": "2024-04-12"}
    },
    "custom_url": "https://google.com"
}'

{
  "success": 1
}

This endpoint sends a formatted email that contains the dashboard screenshot in the email itself. The email format is configured in the Explo application. This endpoint is rate limited based on the corresponding docs here.

If a dashboard version is tagged with an email environment tag, that version will be used for the emails. Otherwise, the version tagged with production will be used. If both do not exist, then it will use the most recent version or draft.

​
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.

​
custom_url
string

A custom url for the screenshot to link to. If not provided, it will use Explo’s share link.

​
Response

​
success
number

Indicates whether the call was successful initiated. 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": {
        "url": "https://google.com",
        "date_range":{"startDate": "2024-04-09","endDate": "2024-04-12"}
    },
    "custom_url": "https://google.com"
}'

{
  "success": 1
}
Email Dashboard Screenshot as AttachmentPartners Endpoints