Retrieve a widget

curl --request GET \
  --url https://api.eu.bronto.io/widgets/{id} \
  --header 'X-BRONTO-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-BRONTO-API-KEY': '<api-key>'}};

fetch('https://api.eu.bronto.io/widgets/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eu.bronto.io/widgets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BRONTO-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eu.bronto.io/widgets/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BRONTO-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eu.bronto.io/widgets/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "code": 404,
  "type": "Not Found",
  "correlation_id": "605f832bcfe44a1081441691c8d42253",
  "details": "Resource not found."
}

{
  "code": 429,
  "type": "Too Many Requests",
  "correlation_id": "53909ed43c544531b7a555e295960437",
  "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window."
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

GET

widgets

{id}

Retrieve a widget

curl --request GET \
  --url https://api.eu.bronto.io/widgets/{id} \
  --header 'X-BRONTO-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-BRONTO-API-KEY': '<api-key>'}};

fetch('https://api.eu.bronto.io/widgets/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eu.bronto.io/widgets/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BRONTO-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eu.bronto.io/widgets/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BRONTO-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eu.bronto.io/widgets/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "code": 404,
  "type": "Not Found",
  "correlation_id": "605f832bcfe44a1081441691c8d42253",
  "details": "Resource not found."
}

{
  "code": 429,
  "type": "Too Many Requests",
  "correlation_id": "53909ed43c544531b7a555e295960437",
  "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window."
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

Authorizations

X-BRONTO-API-KEY

string

header

required

Path Parameters

string<uuid>

required

Widget ID

Response

Widget successfully retrieved

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.

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.

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
    }
  ]
}

API overview

api-keys

users

groups

search

context

live-tail

logs

datasets

monitors

dashboards

collections

access

downtimes

events

forward

roles

top-keys

widgets

integrations

exports

customers

tags

limits

permissions

ai

policies

encryption-keys

metrics

timeseries

patterns

Retrieve a widget

Authorizations

Path Parameters

Response