Get Snapshot URL

Get PDF/Image Snapshot URL

POST https://api.explo.co/export/dashboard/(pdf|image)/

This endpoint returns a URL to a PDF or image snapshot of a dashboard for a given user group. Use /pdf for a PDF and /image for an image.

Request Body

Name	Type	Description
user_group_token	string	This is the ID you use to identify a user group in your database.
dashboard_embed_id	string	The dashboard ID retrieved form the "Embed" menu on the Explo home page.
version_number	number	The version of the dashboard you want to fetch. If empty, the most recent version will be used.
width	number	Width in pixels of snapshot (only applies to Image, not PDF). Default width of the image is 2000px
variable_query	string	A string of query parameters to be passed to your dashboard (e.g. "?dropdown-2=5")

200 File successfully created.

{
    "success": 1,
    "screenshot_url": "https://explo-dashboard-screenshots.s3-us-west-1.amazonaws.com/....."
}

Response field descriptions

Field Name	Type	Description
success	number	Indicates whether the call was successful. 1 if successful, 0 if not.
screenshot_url	string	URL for the generated export file

Example Request

curl --location --request POST 'https://api.explo.co/export/dashboard/pdf/' \
--data-raw '{
    "user_group_token": "<user group token>",
    "dashboard_embed_id": "<dashboard embed ID>"
}'