MEmetabase
/api/dashboard

POST /api/dashboard/{id}/pdf

Changed on

Render Dashboard with ID to a PDF (server-side, the same way dashboard subscriptions render charts) and stream it back as a file download.

parameters are runtime parameter overrides -- the same shape the dashcard query endpoints accept: a sequence of {:id ... :value ...} maps, or a JSON-encoded string of that sequence (the string form lets an HTML <form> action drive the download). Parameters left unspecified fall back to the dashboard's own defaults.

paper_size is "a4" (default) or "letter".

post/api/dashboard/{id}/pdf

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

paper_size'a4' | 'letter' nullable

Response

Successful response

unknown required

Changes