Sign in
dashboards

Create Widget

Create a widget on a dashboard.

post/api/v1/dashboards/{dashboard_id}/widgets

Path parameters

dashboard_idstring uuid required

Request body

titlestring required
viz_type'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap' required
configobject
positionobject

Grid placement {x, y, w, h}. OMIT to have the server append the widget below the existing layout at the default size for this viz_type.

Response

Successful Response

idstring uuid required
dashboard_idstring uuid required
titlestring required
viz_type'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap' required
configobject required
positionobject required
is_systemboolean
source_kind'system' | 'user' nullable
source_refstring nullable
source_config_snapshotobject nullable
source_viz_snapshot'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap'
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 28 revisions of this API.2

  • d65b8fefae342See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 28 revisions, 1 has no diff computed.