Skip to main content

List Scorecards



List Scorecards


Query Parameters

    showDrafts boolean



    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

  • ]