Skip to main content
POST
Aggregate vault-wide health stats

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
vault
enum<string>
required

Vault scope to summarise

Available options:
personal,
instance,
account
institution
string

Optional institution _id, only honored on the instance vault for cross-instance admin views.

Response

Summary returned

success
boolean
Example:

true

summary
object
grade
object

Composite vault-health grade derived from the summary counts. Lets API consumers (UI, dashboards) display a single A–F letter + 0–100 score without re-implementing the rules client-side.

Severity weights per category (penalty per 100% of total):

  • Critical (50pts): errorCount, unindexedCount, missingTerminalCount
  • Degraded (25pts): unoptimizedCount, staleBaseUrlCount
  • Stale (10pts): neverUsedCount, staleCount
  • Unknown (5pts): unscannedCount

score = 100 − Σ (weight × count / totalCount), clamped to ≥0. Letter: 90+ A, 80+ B, 70+ C, 60+ D, else F. Empty vault returns { letter: 'N/A', score: null, factors: [] }.