Dashboard v3

What switching format would do

The format dialog's ledger: what carries over unchanged, what the floor would add for the new style, and what the target format cannot display. Computed by dry-running the REAL floor on a copy — never by re-describing its rules in a second place, which drifts out of truth on the first rule change. Side-effect free: nothing is persisted, so the dialog can be opened and dismissed freely (mirrors the BI-export pre-flight).

get/dashboards/{dashboard_id}/format-preview

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/format-preview
  • 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

Query parameters

stylestring required

Response

What a format switch would do

stylestring required

The style being previewed

charts_carriedinteger

Chart tiles that carry over unchanged

kpis_carriedinteger

KPI cards that carry over

filters_carriedinteger

Declared filters that carry over

pages_afterinteger

Pages the board would have after the switch

filters_addedinteger

Filter-sidebar entries the floor would add

pages_addedstring[]

Titles of content pages the floor would add

cover_addedboolean

A document cover would be prepended

qa_addedboolean

A Q&A tab would be added

Changes

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