---
title: "Motion-story video export state (never kicks a render)"
method: GET
path: "/dashboards/{dashboard_id}/video-state"
tags: ["Dashboard v3"]
---

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

`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`

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.

## Path parameters

- `dashboard_id` integer, required

## Query parameters

- `aspect` 'landscape' | 'square' | 'portrait' | 'null', nullable

## Response `200`

Request fulfilled, document follows

- VideoStateResponse
  - `status` 'none' | 'ready' | 'stale', required
  - `stale` boolean, required
  - `sequence` integer, nullable
  - `seconds` number, nullable
  - `bytes` integer, nullable
  - `url` string, nullable
  - `blocked` 'rls' | 'null', nullable
  - `blocked_reason` string, nullable

## Other responses

- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/fe078afe239b?raw)