List available widgets

GET 
/api/v1/widgets/available

Returns the single panels (boxes) available from the configured Kibana and Grafana dashboards, grouped by source so the user can see where each panel comes from.

Request

Responses

200

application/json

Schema

Schema

builtin

object[]

required

Built-in UI panels the workspace ships with (download, notifications, deploy status)

Array [

source stringrequired

Possible values: [kibana, grafana, builtin]

type stringrequired

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

dashboardId string

Dashboard id (Kibana) or uid (Grafana)

dashboardTitle string

builtinKey string

Built-in panel key (for built-in widgets)

panelId object

Grafana panel id

visualizationId string

Kibana visualization id

panelRefName string

Kibana panel reference name

title stringrequired

Panel title

panelType string

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

defaultWidthPercent numberrequired

Suggested initial width, as a percentage of the dashboard width

defaultHeightPercent numberrequired

Suggested initial height, as a percentage of the visible dashboard height

baseUrl string

Public base url of the source service

embedUrl string

Full url the UI can embed to render the single panel

]

kibana

object[]

required

Panels available from Kibana dashboards

Array [

source stringrequired

Possible values: [kibana, grafana, builtin]

type stringrequired

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

dashboardId string

Dashboard id (Kibana) or uid (Grafana)

dashboardTitle string

builtinKey string

Built-in panel key (for built-in widgets)

panelId object

Grafana panel id

visualizationId string

Kibana visualization id

panelRefName string

Kibana panel reference name

title stringrequired

Panel title

panelType string

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

defaultWidthPercent numberrequired

Suggested initial width, as a percentage of the dashboard width

defaultHeightPercent numberrequired

Suggested initial height, as a percentage of the visible dashboard height

baseUrl string

Public base url of the source service

embedUrl string

Full url the UI can embed to render the single panel

]

grafana

object[]

required

Panels available from Grafana dashboards

Array [

source stringrequired

Possible values: [kibana, grafana, builtin]

type stringrequired

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

dashboardId string

Dashboard id (Kibana) or uid (Grafana)

dashboardTitle string

builtinKey string

Built-in panel key (for built-in widgets)

panelId object

Grafana panel id

visualizationId string

Kibana visualization id

panelRefName string

Kibana panel reference name

title stringrequired

Panel title

panelType string

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

defaultWidthPercent numberrequired

Suggested initial width, as a percentage of the dashboard width

defaultHeightPercent numberrequired

Suggested initial height, as a percentage of the visible dashboard height

baseUrl string

Public base url of the source service

embedUrl string

Full url the UI can embed to render the single panel

]

Example (from schema)

{
  "builtin": [
    {
      "source": "kibana",
      "type": "kibana",
      "dashboardId": "string",
      "dashboardTitle": "string",
      "builtinKey": "string",
      "panelId": {},
      "visualizationId": "string",
      "panelRefName": "string",
      "title": "string",
      "panelType": "string",
      "defaultWidthPercent": 0,
      "defaultHeightPercent": 0,
      "baseUrl": "string",
      "embedUrl": "string"
    }
  ],
  "kibana": [
    {
      "source": "kibana",
      "type": "kibana",
      "dashboardId": "string",
      "dashboardTitle": "string",
      "builtinKey": "string",
      "panelId": {},
      "visualizationId": "string",
      "panelRefName": "string",
      "title": "string",
      "panelType": "string",
      "defaultWidthPercent": 0,
      "defaultHeightPercent": 0,
      "baseUrl": "string",
      "embedUrl": "string"
    }
  ],
  "grafana": [
    {
      "source": "kibana",
      "type": "kibana",
      "dashboardId": "string",
      "dashboardTitle": "string",
      "builtinKey": "string",
      "panelId": {},
      "visualizationId": "string",
      "panelRefName": "string",
      "title": "string",
      "panelType": "string",
      "defaultWidthPercent": 0,
      "defaultHeightPercent": 0,
      "baseUrl": "string",
      "embedUrl": "string"
    }
  ]
}

Loading...