Skip to content
GitmoapAPIBeta
Schema

ScorecardAggregate

How many services a scorecard could score, and how many it could not. External services have nothing to measure, so they are counted separately rather than mixed into the totals.

Shape

  • scoredScoredPartition
    • The ScoredPartition schema
    • checksCheckStateCountsSummed over every scored service's checks.
      • The CheckStateCounts schema
      • expiredinteger · int320–∞
      • failinginteger · int320–∞
      • not_applicableinteger · int320–∞
      • passinginteger · int320–∞
      • staleinteger · int320–∞
      • unknowninteger · int320–∞
    • totalinteger · int320–∞
    • unleveledinteger · int320–∞Services reaching no level at all — including every service on a scorecard with no levels.
    • by_levelobjectoptionalServices at each named level. Absent levels are absent keys, not zeroes.
  • unscoredUnscoredPartition
    • The UnscoredPartition schema
    • externalinteger · int320–∞Services marked external, which the platform cannot measure.
    • totalinteger · int320–∞
    • reasonstring or nulloptionalWhy nothing could be derived, in one phrase a page can render beside the number.

Example

Synthesized example
{
"scored": {
"checks": {
"expired": 46,
"failing": 2,
"not_applicable": 48,
"passing": 11,
"stale": 33,
"unknown": 31
},
"total": 2,
"unleveled": 50,
"by_level": {}
},
"unscored": {
"external": 79,
"total": 5,
"reason": "reason-120b"
}
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.