dashboards

Add an element to a page.

The granular create: adds one panel — validated against the element schema — without round-tripping the whole spec. The element is placed into the page's layout at (x, y, w, h) on every breakpoint, the page is versioned, and a new dashboard revision is written. Refused on legacy (pre-decomposition) dashboards (409 legacy-dashboard). Editor or above.

post/v1/dashboards/{id}/pages/{pageId}/elements

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/dashboards/{id}/pages/{pageId}/elements
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

slugstring

Optional; generated from the title when omitted.

typestring required
titlestring
dataobject
specobject
overridesobject
subtitlestring

Optional panel subtitle (DVT-3543).

drillobject

Legacy drill-down block (DVT-3543).

contextMenuobject

Right-click context menu binding (DVT-3543).

brushobject

Brush-select interaction binding (DVT-3543).

onClickobject

Single bare click-action binding — filter, drill, or openOverlay (DVT-3543).

xinteger
yinteger
winteger
hinteger
zIndexinteger
reasonstring required

Required provenance note (the "why") explaining this change; recorded on the element's initial revision (DVT-1658) and propagated into the dashboard revision's change summary so the Versions tab shows why the change was made (DVT-1792). May also be supplied via the X-Dvt-Change-Reason header. 1–280 characters.

Example request

{
  "type": "chart:bar"
}

Response

Element created (version 1), with themeContext.

Example response

{
  "data": {
    "type": "chart:bar"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.