Skip to content
GitmoapAPIBeta
Schema

Scorecard

A rubric of checks owned by a group or repository and applied to the services beneath it. Scorecards add up rather than override one another: an organization-wide baseline and a team's own bar both hold, and a subgroup cannot switch off a scorecard defined above it.

Shape

  • applies_toServiceSelector
    • The ServiceSelector schema
    • annotationsobjectoptionalAnnotations a service must carry, as key–value pairs. Every entry must match; a service with extra annotations still matches.
    • kindsarray of ServiceKind: one of service | library | website | job | datastore | api | ml_model | otheroptional
    • lifecyclesarray of ServiceLifecycle: one of experimental | production | deprecated | retiredoptional
  • campaign_activebooleanWhether the scorecard's campaign is on. Checks that open work items on failure do so only while it is.
  • campaign_enforcedbooleanWhether the platform acts on campaign_active. Always true.
  • campaign_item_countinteger · int320–∞How many work items the campaign has filed since it was last switched on. Read-only.
  • campaign_max_itemsinteger · int320–∞How many work items the campaign may file each time it is switched on. The count starts from zero every time campaign_active is turned on.
  • checksarray of ScorecardCheck
    • The ScorecardCheck schema
    • keyCheckKey (string)The built-in check's key for a derived check; your own name for the check otherwise.
    • ruleCheckRule
    • configobjectoptionalThe check's own parameters, such as {"days": 90} for released_within. An unknown parameter is refused with a 400 rather than ignored.
    • creates_work_itembooleanoptionalWhether a failure opens a work item in the owning group's backlog. Off by default, and it takes effect only while the scorecard's campaign is active.
  • created_atstring
  • enabledboolean
  • namestring
  • scopeScopeRefThe owning scope — a group or a repository.
  • scorecard_idScorecardId (string · uuid)
  • slugScorecardSlug (string)
  • updated_atstring
  • versioninteger · int64The scorecard's revision, incremented on every change. Send it with an update to have the update refused with a 409 if someone changed the scorecard since you read it.
  • created_byActorSummary or nulloptional
  • descriptionstring or nulloptional
  • levelsarray of ScorecardLeveloptional

Example

Synthesized example
{
"applies_to": {
"annotations": {},
"kinds": [
"service",
"service"
],
"lifecycles": [
"experimental",
"experimental"
]
},
"campaign_active": false,
"campaign_enforced": false,
"campaign_item_count": 2,
"campaign_max_items": 16,
"checks": [
{
"key": "key-22d7",
"rule": {
"type": "derived"
}
}
],
"created_at": "2026-10-16T22:43:28Z",
"enabled": true,
"name": "payments-api",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"scorecard_id": "d54d89e7-6525-472b-a3e4-86a58acf7f18",
"slug": "slug-e160",
"updated_at": "2026-10-10T06:23:22Z",
"version": 86,
"created_by": {
"email": "mara@acme.example",
"id": "id-5af7",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/4011bb8b"
},
"description": "Renders each region as density contours of its operations.",
"levels": [
{
"name": "payments-api",
"required_check_keys": []
}
]
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 3 operations