v1

latestOpenAPI 3.1.02026-07-174824.1 KB
Dashboard

Global KPI bar metrics

Returns the seven aggregate metrics shown in the sticky KPI bar across all four dashboard tabs. Fetch once on page load; refresh after any write action.

get/ossprey/metrics

Response

KPI metrics.

totalPackagesinteger required

Total critical packages (is_critical = true).

criticalPackagesinteger required

Critical packages with at least one critical-severity advisory.

coveragePercentnumber float required

Percentage of critical packages with status in (assessing, active, needs_attention). One decimal place.

coverageTrendnumber nullable

Percentage-point change vs. previous month. Null until snapshot mechanism is implemented.

activeStewardsinteger required

COUNT(DISTINCT user_id) from stewardship_stewards where deleted_at IS NULL and stewardship status != inactive.

unassignedCriticalinteger required

Critical packages with no stewardship row or status = unassigned.

needsAttentioninteger required

Critical packages with status = needs_attention.

escalatedinteger required

Critical packages with status = escalated.

Example response

{
  "totalPackages": 1842,
  "criticalPackages": 312,
  "coveragePercent": 33.2,
  "activeStewards": 42,
  "unassignedCritical": 1230,
  "needsAttention": 47,
  "escalated": 8
}
All 4 operations