Skip to content

get_dashboard_version

Read back one archived snapshot's body without restoring it. Parameters, the base64 return shape, errors and scope rules.

Reads back the body of one prior snapshot, base64-encoded. Use it to inspect or diff a snapshot before deciding whether to restore it. It does not change the live dashboard.

Behaviour hints for clients: read-only, not open-world.

Parameters

ParameterTypeRequiredNotes
slugstringyesCanonical slug of the dashboard the version belongs to.
version_idstringyesA UUID belonging to this dashboard, from list_dashboard_versions.
workspacestringnoWorkspace slug.

Returns

Version 2c91... of revenue-overview ("Before redesign").
Captured: 2026-07-29T12:04:11Z
Content-Type: text/html
Bytes: 47210
Body (base64): PCFET0NUWVBFIGh0bWw+...

The ("<label>") suffix is omitted when the version is unnamed. Missing fields render as unknown.

Errors

The same set as restore_dashboard_version, plus two that are specific to reading the bytes:

ConditionText
The snapshot row exists but its object does notversion body not found
The object read failedversion body read failed: <err>

version body not found means a pruned or orphaned object: the version is listed, but its bytes are gone. That is different from version not found, which means the version itself cannot be used.

The archive key must match the canonical layout exactly. Anything else is reported as version not found rather than as a distinct error.

Scope

Workspace-capable. The version archive is a single namespace shared by both scopes, so only the lookups change scope; the read of the archived bytes is identical.

Check it worked

Decode the body and compare its length against the Bytes: line. To confirm you picked the right snapshot, diff it against the live body from get_dashboard before restoring.

Last updated 2026-08-04