Create a widget

POST /widgets

Create a widget

cURL

curl --request POST \
  --url https://api.eu.bronto.io/widgets \
  --header 'Content-Type: application/json' \
  --header 'X-BRONTO-API-KEY: <api-key>' \
  --data '
{
  "name": "5xx errors by service",
  "type": "treemap",
  "description": "This widget shows the 5xx errors by service",
  "aux": {},
  "sources": [
    {
      "type": "metric",
      "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
    },
    {
      "type": "slo",
      "id": "91bd5a3e-2c4f-4d6a-8b0c-2e4f6a8c0d1e"
    }
  ],
  "metric_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "widget_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "5xx errors by service",
  "type": "area",
  "sources": [
    {
      "type": "metric",
      "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
    },
    {
      "type": "monitor",
      "id": "3f9e2c1a-7b4d-4e8f-9a2b-1c3d5e7f9a0b"
    }
  ],
  "aux": {},
  "description": "This widget shows the 5xx errors by service",
  "metric_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "widget_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "metric_labels": {},
  "layout": {
    "widget_layouts": [
      {
        "id": "78739235-9aa7-4eca-b7f3-4cf6ee455b8f",
        "x": 1.25,
        "y": 2,
        "w": 20,
        "h": 5
      }
    ]
  },
  "tags": {
    "region": "eu",
    "environment": "production"
  },
  "template": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "arguments": {
      "from": {
        "value": {
          "value": "a157b003-d5b8-4333-a3e2-7c7864300852"
        }
      },
      "region": {
        "value": {
          "input": "region"
        }
      }
    }
  },
  "metadata": {
    "created_at": 123,
    "created_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "modified_at": 123,
    "modified_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "deleted_at": 123,
    "deleted_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "last_heartbeat_at": 1791331200000
  }
}

Authorizations

ApiKeyAuthBearerAuth

X-BRONTO-API-KEY · string · header · required

Body

application/json

name · string · required

The widget name

Required string length: 1 - 255

Example:

"5xx errors by service"

type · string · required

The widget type

Required string length: 1 - 64

Example:

"treemap"

description · string

The widget description

Required string length: 1 - 1024

Example:

"This widget shows the 5xx errors by service"

aux · object

Additional widget configuration

sources · object[]

The metrics, monitors and SLOs that supply data to the widget, in display order. Used by every widget type except group. Cannot be combined with metric_ids or widget_ids.

Maximum array length: 20

Show child attributes

Example:

[
  {
    "type": "metric",
    "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
  },
  {
    "type": "slo",
    "id": "91bd5a3e-2c4f-4d6a-8b0c-2e4f6a8c0d1e"
  }
]

metric_ids · string<uuid>[] · deprecated

Deprecated on 2026-10-12 and will be removed on 2027-10-12: use sources with type: metric. Requests using this field receive Deprecation and Sunset response headers. Each ID is stored as {type: metric, id}. Cannot be combined with sources or widget_ids.

Maximum array length: 20

widget_ids · string<uuid>[]

The child widget IDs of a group widget. Required for group widgets and must be omitted for all other widget types. Cannot be combined with sources or metric_ids.

Maximum array length: 50

Response

201

application/json

Widget created successfully

A widget. A group widget contains other widgets (widget_ids, positioned by layout); every other widget type gets its data from sources. A widget never has both sources and widget_ids.

id · string<uuid> · required

name · string · required

The name of the Widget.

Example:

"5xx errors by service"

type · enum<string> · required

The type of the Widget.

Available options: area, bar, donut, events-list, geomap, group, line, pie, score, table, top-list, treemap

sources · object[] · required

The metrics, monitors and SLOs that supply data to the widget, in display order. Empty for group widgets.

Show child attributes

Example:

[
  {
    "type": "metric",
    "id": "7a1c4e2b-0d3f-4a5b-8c6d-9e0f1a2b3c4d"
  },
  {
    "type": "monitor",
    "id": "3f9e2c1a-7b4d-4e8f-9a2b-1c3d5e7f9a0b"
  }
]

aux · object · required

Additional widget configuration

Show child attributes

description · string

A description of the widget

Example:

"This widget shows the 5xx errors by service"

metric_ids · string<uuid>[] · deprecated

Deprecated on 2026-10-12 and will be removed on 2027-10-12: use sources. Contains only the IDs of sources entries whose type is metric.

widget_ids · string<uuid>[]

The child widget IDs of a group widget. Empty for all other widget types.

metric_labels · object

Display labels for the widget's metrics, keyed by metric ID

Show child attributes

layout · object

The positions of the child widgets of a group widget, keyed by child widget ID. widget_layouts is empty for all other widget types.

Show child attributes

Example:

{
  "widget_layouts": [
    {
      "id": "78739235-9aa7-4eca-b7f3-4cf6ee455b8f",
      "x": 1.25,
      "y": 2,
      "w": 20,
      "h": 5
    }
  ]
}

tags · object

A map of key value pairs associated with the resource

Show child attributes

Example:

{
  "region": "eu",
  "environment": "production"
}

template · object

Show child attributes

metadata · object

Common metadata attached to all persisted resources.

Show child attributes