v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Scorecards

List Scorecard Criteria

Lists criteria, including passing service counts, belonging to a scorecard.

get/v1/scorecards/{id}/criteria

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Filters a collection of criteria belonging to a scorecard.

{
  "evaluation.passing_services_count": 21
}
sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are:

  • evaluation.passing_services_count

By default, criteria will be returned in the order that they are configured in the scorecard.

Response

A paginated list response for a collection of criteria belonging to a scorecard.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "5c1121f9-3f3a-47c7-9bb6-c81a51128714",
      "name": "Time to restore service is less than 6 hours over the last 3 months.",
      "scorecard_id": "f3704e4c-104d-4f21-998a-20d4364c893f",
      "enabled": true,
      "template_name": "time_to_merge",
      "template_parameters": {
        "measure": "median",
        "threshold": {
          "unit": "hours",
          "value": 6
        },
        "window": {
          "unit": "months",
          "value": 3
        }
      },
      "section_name": "Documentation",
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z",
      "evaluation": {
        "passing_services_count": 3
      }
    }
  ]
}