Dashboard v3 Surfaces

Read an example report into an editable spec

An example the user SHOWS instead of describing -> the spec for rebuilding its shape: format, cover, ordered sections, palette and number convention, plus not_matched naming what the canvas cannot reproduce. A starting point the editor makes editable — never a promise to match the example.

post/dashboards/v3/exemplar/extract

Request

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

Response

An editable spec read from an example report

specobject nullable
rejectedobject nullable
sourceobject
palettestring[]
measuresstring[]
countablestring[]
brandobject
scopesobject[]

Changes

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