Dashboard v3

Kick a draft-dashboard PDF export

Start an on-demand async export of the editor's current (DRAFT) canvas to a PDF via dash-render. Returns a job_id; poll /jobs/{id} for {stage, progress} then the resolved {bytes, filename, sequence}, and GET /{id}/pdf/{job_id} for the bytes. The canvas version is pinned at submit and the client-hydrated data map is stashed server-side (kept off the Celery args — it can be MBs). Async because a synchronous Chromium print can outlive the proxy / client timeouts held on the request. Auth mirrors /data (author or viewer).

post/dashboards/{dashboard_id}/pdf

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/pdf
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

dashboard_idinteger required

Request body

Response

Document created, URL follows

status_codeinteger nullable
job_idinteger nullable

Created job id

failure_reasonstring nullable

Failure reason if status is failure

Changes

No recorded changes to this operation across all 5 revisions of this API.