---
title: "Check Group"
canonical_url: "https://docs.getdx.com/webapi/types/check-group/"
md_url: "https://docs.getdx.com/webapi/types/check-group.md"
last_updated: "2026-05-19"
---

# Check Group
A definition for a check group in a points-based scorecard.

## Example

```json
{
  "id": "observability",
  "name": "Observability",
  "ordering": 1
}
```

## Properties

| Key        | Type   | Description                                                                              |
| ---------- | ------ | ---------------------------------------------------------------------------------------- |
| `id`       | string | ID for the check group.                                                                  |
| `name`     | string | Human-readable name for the check group (e.g. Observability, Deployments, Unit testing). |
| `ordering` | number | The check group's ordering compared to the scorecard's other check groups.               |

## Additional properties required in a request body

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

## Sitemap

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