---
title: "Health Overview"
method: GET
path: "/snapshots/{snapshot_id}/health/overview"
tags: ["code-health"]
---

# Health Overview

`GET /snapshots/{snapshot_id}/health/overview`

## Path parameters

- `snapshot_id` string, required

## Query parameters

- `limit` integer
- `scope` string
- `counts` string

## Response `200`

Successful Response

- HealthOverviewResponse
  - `kpis` HealthKpis, required
    - `hotspot_health` number, nullable
    - `hotspot_health_measured` number, nullable
    - `average_health` number, required
    - `worst_performer_path` string, nullable
    - `worst_performer_score` number, nullable
    - `file_count` integer
    - `maintainability_average` number, nullable
    - `performance_average` number, nullable
    - `maintainability_findings` integer
    - `performance_findings` integer
    - `band` 'excellent' | 'good' | 'fair' | 'needs_work' | 'at_risk', nullable
    - `scope` string
    - `counts` string
    - `unscored_files` integer
    - `structure_average` number, nullable
    - `structure_hotspot` number, nullable
    - `history_average` number, nullable
    - `history_hotspot` number, nullable
    - `maintainability_hotspot` number, nullable
    - `performance_hotspot` number, nullable
    - `production_average` number, nullable
    - `production_file_count` integer
  - `files` HealthFileMetric[]
    - `file_path` string, required
    - `score` number, required
    - `band` 'excellent' | 'good' | 'fair' | 'needs_work' | 'at_risk', nullable
    - `max_ccn` integer
    - `max_nesting` integer
    - `nloc` integer
    - `duplication_pct` number, nullable
    - `has_test_file` boolean
    - `line_coverage_pct` number, nullable
    - `branch_coverage_pct` number, nullable
    - `module` string, nullable
    - `defect_score` number, nullable
    - `maintainability_score` number, nullable
    - `performance_score` number, nullable
    - `structure_deduction` number, nullable
    - `history_deduction` number, nullable
    - `unclamped_score` number, nullable
    - `performance_findings` integer
    - `performance_analyzed` boolean, nullable
    - `primary_biomarker` string, nullable
    - `primary_reason` string, nullable
    - `total_deduction` number, nullable
    - `top_biomarkers` BiomarkerFinding[]
      - `id` string, required
      - `biomarker_type` string, required
      - `severity` string, required
      - `file_path` string, required
      - `function_name` string, nullable
      - `line_start` integer, nullable
      - `line_end` integer, nullable
      - `details` object
      - `health_impact` number
      - `reason` string
      - `status` string
      - `suggestion` string, nullable
      - `dimension` string
      - `symbol_id` string, nullable
      - `is_test` boolean
    - `is_test` boolean
  - `biomarkers` BiomarkerFinding[]
    - `id` string, required
    - `biomarker_type` string, required
    - `severity` string, required
    - `file_path` string, required
    - `function_name` string, nullable
    - `line_start` integer, nullable
    - `line_end` integer, nullable
    - `details` object
    - `health_impact` number
    - `reason` string
    - `status` string
    - `suggestion` string, nullable
    - `dimension` string
    - `symbol_id` string, nullable
    - `is_test` boolean
  - `test_biomarkers` BiomarkerFinding[]
    - `id` string, required
    - `biomarker_type` string, required
    - `severity` string, required
    - `file_path` string, required
    - `function_name` string, nullable
    - `line_start` integer, nullable
    - `line_end` integer, nullable
    - `details` object
    - `health_impact` number
    - `reason` string
    - `status` string
    - `suggestion` string, nullable
    - `dimension` string
    - `symbol_id` string, nullable
    - `is_test` boolean
  - `biomarkers_total` integer
  - `test_biomarkers_total` integer
  - `modules` HealthModuleRollup[]
    - `module` string, required
    - `file_count` integer, required
    - `average_health` number, required
    - `worst_file_path` string, nullable
    - `worst_file_score` number, nullable
    - `nloc_weighted_health` number, required
    - `critical_finding_count` integer
    - `warning_finding_count` integer
  - `defect_accuracy` DefectAccuracy — How well the lowest-health files line up with files that were actually bug-fixed recently. Computed from the health.json artifact; null when the repo lacks enough files / defect history to be honest.
    - `k` integer, required
    - `hits` integer, required
    - `precision` number, required
    - `base_rate` number, required
    - `lift` number, nullable
    - `window_days` integer
    - `scored_files` integer, required
    - `defect_files` integer, required
    - `concentration_file_fraction` number, required
    - `concentration_defect_share` number, required
    - `precision_table` DefectAccuracyPoint[]
      - `k` integer, required
      - `hits` integer, required
    - `flagged_files` DefectAccuracyFile[]
      - `file_path` string, required
      - `score` number, required
      - `recent_fixes` integer, required
  - `meta` HealthMeta
    - `last_indexed_at` string, nullable
    - `head_commit` string, nullable
    - `snapshot_count` integer
  - `state` string
  - `reason` string, nullable
  - `scope` string
  - `counts` string
  - `distribution` object
  - `unscored_files` integer

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-14** `c3d46dfc6e3d` — 2 breaking, 5 warning, 21 info
  - the response property `kpis/hotspot_health` became optional for the status `200`
  - response property `kpis/hotspot_health` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - added the new `at_risk` enum value to the `files/items/band/anyOf[subschema #1]/` response property for the response status `200`
  - added the new `excellent` enum value to the `files/items/band/anyOf[subschema #1]/` response property for the response status `200`
  - …24 more

[Change history](https://skmtc.dev/repowise/apis/repowise-hosted-api/changes/snapshots/:snapshot_id/health/overview/get.md)

---

[API](https://skmtc.dev/repowise/apis/repowise-hosted-api.md) · [All operations](https://skmtc.dev/repowise/apis/repowise-hosted-api/llms.txt) · [OpenAPI document](https://skmtc.dev/repowise/apis/repowise-hosted-api/revisions/d1694e41a8a1?raw)