---
title: "Scorecard Report"
canonical_url: "https://docs.getdx.com/webapi/types/scorecard-report/"
md_url: "https://docs.getdx.com/webapi/types/scorecard-report.md"
last_updated: "2026-05-08"
---

# Scorecard Report
Details about a scorecard and its checks, combined with info about a specific entity's current level and check results within the scorecard.

## Example

```json
{
  "id": "production-readiness",
  "name": "Production Readiness",
  "type": "LEVEL",
  "tags": [
    {
      "value": "production",
      "color": "#38bdf8"
    }
  ],
  "levels": [
    {
      "id": "bronze",
      "name": "Bronze",
      "color": "#cd7f32",
      "rank": 1
    },
    {
      "id": "silver",
      "name": "Silver",
      "color": "#c0c0c0",
      "rank": 2
    }
  ],
  "current_level": {
    "id": "bronze",
    "name": "Bronze",
    "color": "#cd7f32",
    "rank": 1
  },
  "empty_level": {
    "label": "Not production-ready",
    "color": "#ef4444"
  },
  "checks": [
    {
      "id": "has-readme",
      "name": "Has README",
      "description": "Service has a README file",
      "passed": true,
      "status": "PASS"
    }
  ]
}
```

## Base Properties

| Key      | Type                                               | Description                                                                                  |
| -------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `id`     | string                                             | ID for the scorecard.                                                                        |
| `name`   | string                                             | The name of the scorecard.                                                                   |
| `type`   | string                                             | The type of the scorecard. Valid values are `LEVEL` (level-based) or `POINTS` (points-based) |
| `tags`   | array<Tag>                                         | A list of tags on the scorecard. e.g. `[{"value": "production", "color": "#38bdf8"}]`        |
| `checks` | array<[Check Result](https://docs.getdx.com/webapi/types/check-result/)> | A list of the scorecard's checks and the entity's current results for each one.              |

## Level-based Scorecard Properties

Additional fields for level-based scorecards:

| Key             | Type                                  | Description                                                                                    |
| --------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `levels`        | array<[Level](https://docs.getdx.com/webapi/types/level/)>  | The attainable levels within the scorecard (e.g. Bronze, Silver, Gold).                        |
| `current_level` | [Level](https://docs.getdx.com/webapi/types/level/) \| null | The entity's currently attained level in the scorecard.                                        |
| `empty_level`   | Empty Level Definition                | The label and color to display if the entity has not attained any levels in the scorecard yet. |

## Points-based Scorecard Properties

Additional fields for points-based scorecards:

| Key            | Type                                             | Description                                                |
| -------------- | ------------------------------------------------ | ---------------------------------------------------------- |
| `points_meta`  | [Points Meta](https://docs.getdx.com/webapi/types/points-meta/)        | Points metadata for this entity and scorecard.             |
| `check_groups` | array<[Check Group](https://docs.getdx.com/webapi/types/check-group/)> | Definitions for each of the check groups in the scorecard. |
---

## Sitemap

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