Dashboard v3

Motion-story video export state (never kicks a render)

The publish-menu video state for a dashboard — READ ONLY. Reports {status: none|ready|stale, stale, sequence?, seconds?, bytes?, url?} from stored-clip presence vs. the current published sequence: ready at the current sequence, stale when only an earlier-sequence clip exists (a republish moved the head), none when nothing was ever baked. NEVER triggers a render — the FE polls this on open and only kicks via POST /video. A board with row-level security on has no video surface at all (the clip is one shared object of whole-dataset frames): reports none with {blocked: 'rls', blocked_reason} whatever the store holds. ?aspect=landscape|square|portrait picks which clip is described (omitted: the published story's motion.aspect, else landscape); a non-landscape url carries &aspect=. Auth mirrors /data.

get/dashboards/{dashboard_id}/video-state

Request

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

aspect'landscape' | 'square' | 'portrait' | 'null' nullable

Response

Request fulfilled, document follows

status'none' | 'ready' | 'stale' required
staleboolean required
sequenceinteger nullable
secondsnumber nullable
bytesinteger nullable
urlstring nullable
blocked'rls' | 'null' nullable
blocked_reasonstring nullable

Changes

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