List Scorecards

GET 
/api/v1/scorecards

List Scorecards

Request

Query Parameters

showDrafts boolean

Responses

200

OK

application/json

Schema

Schema

scorecards object[]required
Array [
description string
evaluation object
window int64
Number of hours between Scorecard evaluations. If the evaluation window is not set, the Scorecard is evaluated every 4 hours.
isDraft booleanrequired
levels object[]
Array [
level object
name stringrequired
Name of the level
number int32required
Rank of the level where 1 is the highest
]
name stringrequired
Human-readable name
rules object[]required
Array [
description string
expression stringrequired
CQL representation of the rule
failureMessage string
levelName string
Name of the level this rule is associated with, if applicable
title string
weight number
Numerical weight of the rule. When using levels, this defaults to 1.
]
tag stringrequired
Unique identifier, found in the UI
]

Example (from schema)

{
  "scorecards": [
    {
      "description": "string",
      "evaluation": {
        "window": 4
      },
      "isDraft": true,
      "levels": [
        {
          "level": {
            "name": "Bronze",
            "number": 0
          }
        }
      ],
      "name": "Production Readiness Scorecard",
      "rules": [
        {
          "description": "This rule is very important because you must pass it",
          "expression": "custom(\"key\") = \"value\"",
          "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
          "levelName": "string",
          "title": "Key value must be correct",
          "weight": 0
        }
      ],
      "tag": "production-readiness-scorecard"
    }
  ]
}

Loading...