Skip to main content
PATCH
Rename dashboard

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
required

The new name; surrounding whitespace is trimmed.

Required string length: 1 - 120
Example:

"Weekly revenue"

Response

The dashboard

dashboard
object
version
object | null
spec
object | null

The version's spec: filters, sources, panels (layout: span, height, order; triggers: a stats panel's on_click, a table's row_key, cell_triggers (by column key: the cell value is a link), on_row_click, row_actions), views (what a trigger opens: kind table | stats | chart | … | form | thread | composite, title, presentation drawer | modal, context keys; a form view carries tool, fields, initial, submit_label, on_success, confirm and schema — the JSON Schema of its fields; a composite view carries blocks — data blocks of any component kind, text blocks, at most one form block with its schema — and optional tabs / default_tab), actions (toolbar buttons) and tab_groups (layout only: { id, tabs: [{ id, label }], default?, strip?: card | page | none }; a panel with tab: { group, id } shows only while that tab is open). A trigger is { view, context } or { tab: { group, id } } (select a tab instead of opening a view); context values that are templates ("{{row.id}}", "{{row}}", "{{stat.key}}", "{{stat.value}}", "{{filters.}}") are resolved by the page before it calls the view.

filters
object
data
object | null

The latest refresh, or null when the dashboard was never refreshed.