Export Dashboard

Export an entire dashboard as an Excel or PDF file.

Tool: draxlr_export_dashboard

Exports an entire dashboard group — all of its widgets — as an Excel (.xlsx) workbook or a PDF. The tool returns a short-lived downloadUrl (valid for 5 minutes) that you open in your browser to download the file. Get a dashboardGroupId from List Dashboards.

Parameters

ParameterTypeRequiredDescription
dashboardGroupIdstringYesThe dashboard id to export (from List Dashboards)
formatstringNoExport format: xlsx (default) or pdf
showFiltersbooleanNoPDF only — include the dashboard's filter bar in the output
themestringNoPDF only — render in light (default) or dark theme

Example

"Export the Sales Overview dashboard as a PDF."

Arguments:

{
  "dashboardGroupId": "665f2a119b1e4a0012abd100",
  "format": "pdf"
}

Response

{
  "message": "Your export is ready. Open this link to download dashboard-665f2a119b1e4a0012abd100.pdf (the link expires in 5 minutes):",
  "downloadUrl": "https://api.draxlr.com/mcp/download/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "fileName": "dashboard-665f2a119b1e4a0012abd100.pdf",
  "dashboardGroupId": "665f2a119b1e4a0012abd100",
  "format": "pdf"
}
FieldDescription
messageA human-readable summary, including how long the link is valid
downloadUrlA short-lived link (valid for 5 minutes) to download the file
fileNameThe name the downloaded file will be saved as
dashboardGroupIdThe dashboard that was exported
formatThe format the file was exported in

Excel vs PDF:

Excel exports include one sheet per widget with its underlying data. PDF exports render the dashboard visually, and support the showFilters and theme options.