Check Result

A scorecard check’s definition and an entity’s latest results for that check.

Example

{
  "id": "has-monitoring",
  "name": "Has Monitoring",
  "description": "Service has monitoring and alerting configured",
  "ordering": 2,
  "passed": true,
  "status": "PASS",
  "published": true,
  "output": {
    "value": "95.5",
    "type": "percent"
  },
  "message": "Monitoring coverage is excellent",
  "related_property": null,
  "executed_at": "2024-02-20T10:15:00Z",
  "level": {
    "id": "bronze",
    "name": "Bronze"
  },
  "points": 10
}

Properties

Key	Type	Description
`id`	string	The check’s unique ID.
`name`	string	The check’s name.
`description`	string	The check’s description.
`ordering`	number	The check’s ordering within its level.
`passed`	boolean	Whether the entity is currently passing or failing the check.
`status`	string	Will be one of `PASS`, `WARN`, or `FAIL`.
`published`	boolean	Whether the check has been published or is still in a draft state.
`output`	Check Output \| null	If display values are enabled for the check, this will include the output value and type.
`message`	string	If the check result included a message column, it will be displayed here. Markdown is supported.
`related_property`	string	If the check result included a related_property column referencing a property that needs to be set or changed, it will be displayed here. In the UI, this enables entity owners to quickly edit a missing or outdated property inline.
`executed_at`	ISO8601 timestamp \| null	The date and time when the check was last executed for this entity.
`level`	Partial<Level>	The id and name of the level with which the check is associated. (Level-based scorecards only)
`check_group`	Partial<Check Group>	The id and name of the check group with which the check is associated. (Points-based scorecards only)
`points`	number	The number of points this check is worth. (Points-based scorecards only)

For more details, see the Query result structure section of the scorecards guide.