Dashboard v3

Render one figure to SVG

Render one engine figure spec to a static SVG with no browser and no stored data; the CLI's Explore export uses it. The spec carries its data inline. A malformed spec is a 422; an engine failure is a 503 with the engine message in details.

post/dashboards/v3/render/svg

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/v3/render/svg
  • 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

Request body

specobject required

Engine figure spec: the chart kind, title, width/height, and its data inline (data for charts, rows for a table)

style_idstring nullable

Stock or custom style id; null renders the engine default

Response

The rendered figure as SVG

svgstring required

The rendered figure as an <svg> document

Changes

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