Skip to main content
GET
/
dashboards
/
{dashboard_id}
/
widgets
List widgets
curl --request GET \
  --url https://api.coval.dev/v1/dashboards/{dashboard_id}/widgets \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coval.dev/v1/dashboards/{dashboard_id}/widgets"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coval.dev/v1/dashboards/{dashboard_id}/widgets', 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.coval.dev/v1/dashboards/{dashboard_id}/widgets",
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-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.coval.dev/v1/dashboards/{dashboard_id}/widgets"

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

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/dashboards/{dashboard_id}/widgets")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/dashboards/{dashboard_id}/widgets")

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

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

response = http.request(request)
puts response.read_body
{
  "widgets": [
    {
      "name": "dashboards/abc123def456ghi789jklm/widgets/wgt456xyz789abc012defg",
      "type": "chart",
      "create_time": "2025-10-14T12:00:00Z",
      "update_time": "2025-10-15T14:30:00Z",
      "display_name": "Response Time Chart",
      "grid_x": 123,
      "grid_y": 123,
      "grid_w": 123,
      "grid_h": 123,
      "config": {
        "metricId": "<string>",
        "visualizationType": "line",
        "monitoring": "Monitoring",
        "aggregation": "avg",
        "metricOutputType": "float",
        "stacked": true,
        "grouped": true,
        "showAsPercentage": true,
        "groupBy": "agent",
        "customColorMap": {},
        "xAxisLabel": "<string>",
        "yAxisLabel": "<string>",
        "customSeriesNames": {},
        "hiddenSeries": [
          "<string>"
        ],
        "precision": 1,
        "units": "<string>",
        "showCount": true,
        "showRange": true,
        "showStdDev": true,
        "showBoxPlot": true,
        "showTargetZone": true,
        "filters": {
          "metricIds": [
            "<string>"
          ],
          "agentIds": [
            "<string>"
          ],
          "agentMutationIds": [
            "<string>"
          ],
          "personaIds": [
            "<string>"
          ],
          "templateNames": [
            "<string>"
          ],
          "testSetIds": [
            "<string>"
          ],
          "metadata": [
            {}
          ]
        },
        "metricFilter": [
          {
            "metricId": "<string>",
            "operator": ">=",
            "value": 123,
            "metricOutputType": "float"
          }
        ]
      }
    }
  ],
  "next_page_token": "<string>"
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "<string>",
"description": "<string>"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

dashboard_id
string
required

Dashboard resource ID (22-character ShortUUID)

Query Parameters

page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 100
page_token
string

Opaque pagination token from previous response

Response

Widgets retrieved successfully

widgets
object[]
required
next_page_token
string | null

Token for fetching next page (null if no more results)