---
title: "Level"
canonical_url: "https://docs.getdx.com/webapi/types/level/"
md_url: "https://docs.getdx.com/webapi/types/level.md"
last_updated: "2026-05-19"
---

# Level
A definition for a level in a level-based scorecard.

## Example

```json
{
  "id": "gold",
  "name": "Gold",
  "color": "#ffd700",
  "rank": 3
}
```

## Properties

| Key     | Type   | Description                                                            |
| ------- | ------ | ---------------------------------------------------------------------- |
| `id`    | string | ID for the level.                                                      |
| `name`  | string | Human-readable name for the level (e.g. Bronze, Silver, Gold).         |
| `color` | string | A six-digit hex code for the color of the level's badge (e.g. #fb923c) |
| `rank`  | number | The level's rank compared to the scorecard's other attainable levels.  |

## Additional properties required in a request body

| Key   | Type   | Description                                                                                                                                      |
| ----- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `key` | string | User-defiend key to reference in the `scorecard_level_key` property of a [`Check`](https://docs.getdx.com/webapi/types/check/) that should be nested under this level. |

## Empty Level Definition

A definition for what to show if an entity has not attained any levels in a scorecard yet.

| Key     | Type   | Description                                                                         |
| ------- | ------ | ----------------------------------------------------------------------------------- |
| `label` | string | Human-readable label to show if applicable (e.g. Not production-ready, Incomplete). |
| `color` | string | A six-digit hex code for the color of the badge (e.g. #fb923c)                      |
---

## Sitemap

[Overview of all docs pages](/llms.txt)