---
title: "Dashboard widget types and descriptions"
method: GET
path: "/api/dashboards/widgets"
tags: ["dashboards"]
---

# Dashboard widget types and descriptions

`GET /api/dashboards/widgets`

## Request

- Base URL: `https://codescene.io` (the document declares no server; this is the origin it was published from)
- URL: `https://codescene.io/api/dashboards/widgets`
- Auth: none declared

Widget types and descriptions for widget variants, optionally narrowed to those a scope (area, project, or a project's team or component) can feed.

## Query parameters

- `scope` 'area' | 'project' | 'team' | 'component'

## Response `200`

- object
  - `widgetTypes` object, required
  - `widgetVariants` object, required
    - `CodeHealthKpiCard` object
      - `widgetType` 'kpiCard', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `metrics` object, required
          - `query` 'queries/code-health', required
        - `metricDescription` object, required
          - `query` 'queries/code-health-description', required
        - `weightMetric` object, required
          - `query` 'queries/lines-of-code', required
        - `children` object, required
          - `query` 'queries/code-health-children', required
    - `HotspotCodeHealthKpiCard` object
      - `widgetType` 'kpiCard', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `metrics` object, required
          - `query` 'queries/hotspot-code-health', required
        - `metricDescription` object, required
          - `query` 'queries/hotspot-code-health-description', required
        - `weightMetric` object, required
          - `query` 'queries/lines-of-code', required
        - `children` object, required
          - `query` 'queries/hotspot-code-health-children', required
    - `CodeHealthTrendLineChart` object
      - `widgetType` 'lineChart', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `series` object, required
          - `query` 'queries/code-health-trend', required
        - `thresholds` object, required
          - `query` 'queries/code-health-thresholds', required
        - `contextLines` object, required
          - `query` 'queries/code-health-context-lines', required
    - `HotspotCodeHealthTrendLineChart` object
      - `widgetType` 'lineChart', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `series` object, required
          - `query` 'queries/hotspot-code-health-trend', required
        - `thresholds` object, required
          - `query` 'queries/code-health-thresholds', required
        - `contextLines` object, required
          - `query` 'queries/hotspot-code-health-context-lines', required
    - `CodeCoverageKpiCard` object
      - `widgetType` 'kpiCard', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `metrics` object, required
          - `query` 'queries/code-coverage', required
        - `metricDescription` object, required
          - `query` 'queries/code-coverage-description', required
        - `weightMetric` object, required
          - `query` 'queries/code-coverage-total-loc', required
        - `secondaryWeightMetric` object, required
          - `query` 'queries/code-coverage-covered-loc', required
        - `children` object, required
          - `query` 'queries/code-coverage-children', required
    - `HotspotsTable` object
      - `widgetType` 'table', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `items` object, required
          - `query` 'queries/hotspots', required
    - `PseudoRandomUiObject` object
      - `widgetType` 'pseudoWidget', required
      - `title` string, nullable
      - `category` 'code-health' | 'code-coverage' | 'hotspots' | 'other', required
      - `scopes` string[], required
      - `dashboardAddable` boolean, required
      - `inputs` object, required
        - `xAxis` object, required
          - `query` 'pseudo-queries/horizontal-fake', required
        - `yAxis` object, required
          - `query` 'pseudo-queries/vertical-fake', required

## Other responses

- `400`
- `401`
- `403`
- `404`

## Changes

- **2026-10-19** `e443e0b6bc89`: 14 warning, 2 info
  - added the new `component` enum value to the `widgetVariants/CodeCoverageKpiCard/scopes/items/` response property for the response status `200`
  - added the new `component` enum value to the `widgetVariants/CodeHealthKpiCard/scopes/items/` response property for the response status `200`
  - added the new `component` enum value to the `widgetVariants/CodeHealthTrendLineChart/scopes/items/` response property for the response status `200`
  - added the new `component` enum value to the `widgetVariants/HotspotCodeHealthKpiCard/scopes/items/` response property for the response status `200`
  - …12 more

[Operation history](https://skmtc.dev/codescene/apis/codescene-api/changes/api/dashboards/widgets/get.md)

---

[API](https://skmtc.dev/codescene/apis/codescene-api.md) · [All operations](https://skmtc.dev/codescene/apis/codescene-api/llms.txt) · [OpenAPI document](https://skmtc.dev/codescene/apis/codescene-api/revisions/e443e0b6bc89?raw)