Retrieve Scorecard scores

GET 
/api/v1/scorecards/:tag/scores

Returns latest scores for all entities in the Scorecard

Request

Path Parameters

tag stringrequired
Unique tag for the Scorecard
Example: my-production-readiness-checklist

Query Parameters

entityTag string

Entity tag (x-cortex-tag)

pageSize int32

Number of results to return per page. (Note: If no "pageSize" value is provided, the endpoint will attempt to return all scores.)

page int32

Default value: 0

Page number to return, 0 indexed.

Responses

200

Scorecard scores

application/json

Schema

Schema

scorecardFilter

object

groups

object

Entity groups to include or exclude

exclude string[]

include string[]

query string

CQL expression to apply as a filter

types

object

Entity types (e.g. SERVICE, DOMAIN, TEAM) to include or exclude

exclude string[]

include string[]
scorecardName stringrequired
scorecardTag stringrequired

serviceScores

object[]

required

Array [

lastEvaluated date-timerequired

ruleExemptions

object[]

required

Array [

endDate date-time

exemptionStatus

object

required

date date-time

Date on which the exemption was approved or rejected. Null if the status is pending

handledBy

object

API key or person who requested, approved or rejected the exemption

oneOf

RuleExemptionUserActor

email string

Email of the person who requested, approved or rejected the exemption

name string

Name of the person who requested, approved or rejected the exemption

RuleExemptionApiActor

apiKeyLast4 string

Last 4 digits of the API key used to approve or reject the exemption

status stringrequired

Status of the exemption. Possible values are APPROVED, REJECTED, and PENDING

requestedBy

object

required

API key or person who requested, approved or rejected the exemption

oneOf

RuleExemptionUserActor

email string

Email of the person who requested, approved or rejected the exemption

name string

Name of the person who requested, approved or rejected the exemption

RuleExemptionApiActor

apiKeyLast4 string

Last 4 digits of the API key used to approve or reject the exemption

requestedDate date-timerequired

requestingReason stringrequired

ruleExpression stringrequired

CQL representation of the rule

ruleIdentifier stringrequired

Identifier of the rule

]

score

object

required

ladderLevels

object[]

required

Array [

level

object

name stringrequired

Name of the level

number int32required

Rank of the level where 1 is the highest

]

rules

object[]

required

Array [

error string

expression stringrequired

identifier string

score numberrequired

]

summary

object

required

percentage numberrequired

score numberrequired

totalPossibleScore numberrequired

service

object

required

groups string[]required

Not to be confused with owners. This refers to the x-cortex-groups field of the entity

name stringrequired

owners

object

required

groups string[]required

Not to be confused with x-cortex-groups. These are the slugs of IdP or Cortex Managed Teams

individuals

object[]

required

Array [

description string

email stringrequired

]

tag stringrequired

]

Example (from schema)

{
  "scorecardFilter": {
    "groups": {
      "exclude": [
        "string"
      ],
      "include": [
        "string"
      ]
    },
    "query": "string",
    "types": {
      "exclude": [
        "string"
      ],
      "include": [
        "string"
      ]
    }
  },
  "scorecardName": "string",
  "scorecardTag": "string",
  "serviceScores": [
    {
      "lastEvaluated": "2024-05-02T20:31:54.471Z",
      "ruleExemptions": [
        {
          "endDate": "2024-05-02T20:31:54.471Z",
          "exemptionStatus": {
            "date": "2024-05-02T20:31:54.471Z",
            "handledBy": {},
            "status": "string"
          },
          "requestedBy": {},
          "requestedDate": "2024-05-02T20:31:54.471Z",
          "requestingReason": "string",
          "ruleExpression": "string",
          "ruleIdentifier": "string"
        }
      ],
      "score": {
        "ladderLevels": [
          {
            "level": {
              "name": "Bronze",
              "number": 0
            }
          }
        ],
        "rules": [
          {
            "error": "string",
            "expression": "string",
            "identifier": "string",
            "score": 0
          }
        ],
        "summary": {
          "percentage": 0,
          "score": 0,
          "totalPossibleScore": 0
        }
      },
      "service": {
        "groups": [
          "string"
        ],
        "name": "string",
        "owners": {
          "groups": [
            "string"
          ],
          "individuals": [
            {
              "description": "string",
              "email": "string"
            }
          ]
        },
        "tag": "string"
      }
    }
  ]
}

404

Scorecard not found

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

Loading...