Skip to main content

Create widget

POST 
/api/v1/widgets

Creates a widget on the space dashboard. Use type "kibana"/"grafana" with panelConfig to embed a dashboard panel, or type "text" with textConfig for a sticky note.

Request​

Body

required

    title string

    Widget title shown in the header

    order number

    Zero-based position in the space; other widgets shift accordingly. Defaults to the end on create.

    widthPercent number

    Possible values: >= 1 and <= 100

    Width as a percentage of the dashboard width. Defaults per widget type on create.

    heightPercent number

    Possible values: >= 1 and <= 100

    Height as a percentage of the visible dashboard height. Defaults per widget type on create.

    panelConfig

    object

    source stringrequired

    Possible values: [kibana, grafana, builtin]

    Which service this panel comes from

    dashboardId stringrequired

    Dashboard id (Kibana) or dashboard uid (Grafana) the panel belongs to

    dashboardTitle string

    Human readable dashboard name (helps the user understand where the panel comes from)

    panelId object

    Grafana panel id within the dashboard

    visualizationId string

    Kibana visualization saved-object id for the single panel

    panelRefName string

    Kibana panel reference name within the dashboard

    panelType string

    Panel type (e.g. timeseries, table, visualization)

    baseUrl string

    Public base url of the source service (Kibana/Grafana) the UI should use

    embedUrl string

    Full url the UI can embed/iframe to render the single panel

    textConfig

    object

    body string

    Note body text

    color string

    Background color of the sticky note (e.g. #fff475)

    builtinConfig

    object

    key stringrequired

    Built-in panel key the UI renders

    type stringrequired

    Possible values: [kibana, grafana, text, builtin]

    spaceId string

    Space the widget belongs to. Defaults to the shared default space.

Responses​

Schema

    id numberrequired
    type stringrequired

    Possible values: [kibana, grafana, text, builtin]

    title string
    spaceId stringrequired
    order numberrequired

    Zero-based position in the space; render widgets in this order

    widthPercent numberrequired

    Width as a percentage of the dashboard width

    heightPercent numberrequired

    Height as a percentage of the visible dashboard height

    panelConfig

    object

    source stringrequired

    Possible values: [kibana, grafana, builtin]

    Which service this panel comes from

    dashboardId stringrequired

    Dashboard id (Kibana) or dashboard uid (Grafana) the panel belongs to

    dashboardTitle string

    Human readable dashboard name (helps the user understand where the panel comes from)

    panelId object

    Grafana panel id within the dashboard

    visualizationId string

    Kibana visualization saved-object id for the single panel

    panelRefName string

    Kibana panel reference name within the dashboard

    panelType string

    Panel type (e.g. timeseries, table, visualization)

    baseUrl string

    Public base url of the source service (Kibana/Grafana) the UI should use

    embedUrl string

    Full url the UI can embed/iframe to render the single panel

    textConfig

    object

    body string

    Note body text

    color string

    Background color of the sticky note (e.g. #fff475)

    builtinConfig

    object

    key stringrequired

    Built-in panel key the UI renders

    createdBy string
    createdDate date-timerequired
    lastUpdatedDate date-timerequired
Loading...