COcortex
Scorecards

List Scorecards

Returns scorecards matching optional search criteria. If search criteria is specified we will use search logic, which will not find Scorecards that have yet to be evaluated

get/api/v1/scorecards

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/scorecards
  • Auth
    HTTP bearer

Query parameters

showDraftsboolean
groupsstring[]

Filter based on groups, which correspond to the x-cortex-groups field in the Catalog Descriptor. Accepts a comma-delimited list of groups

entitiesstring[]

Filter based on entity (either tags or CIDs). Accepts a comma-delimited list of entity tag or CIDs, please use only one type of identifier

teamsstring[]

Filter based on team (either tags or CIDs). Accepts a comma-delimited list of team tag or CIDs, please use only one type of identifier

pageinteger required

Page number to return, 0-indexed. Default 0.

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

Response

OK

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "scorecards": [
    {
      "evaluation": {
        "window": 4
      },
      "exemptions": {
        "enabled": true
      },
      "levels": [
        {
          "level": {
            "name": "Bronze"
          }
        }
      ],
      "name": "Production Readiness Scorecard",
      "notifications": {
        "enabled": true,
        "scoreDropNotificationsEnabled": true
      },
      "rules": [
        {
          "description": "This rule is very important because you must pass it",
          "effectiveFrom": "2024-01-01T00:00:00Z",
          "expression": "custom(\"key\") = \"value\"",
          "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
          "identifier": "96db03f1-2529-3fc3-9f13-7fb4dd28f427",
          "title": "Key value must be correct"
        }
      ],
      "tag": "production-readiness-scorecard"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.