---
title: "Returns the packaged Code Health review for a repo-scoped file path."
method: GET
path: "/api/projects/{project-id}/quality/files/code-health-review"
tags: ["quality"]
---

# Returns the packaged Code Health review for a repo-scoped file path.

`GET /api/projects/{project-id}/quality/files/code-health-review`

## Request

- Base URL: `https://codescene.io` (the document declares no server; this is the origin it was published from)
- URL: `https://codescene.io/api/projects/{project-id}/quality/files/code-health-review`
- Auth: none declared

## Path parameters

- `project-id` integer, required

## Query parameters

- `path` string, required

## Response `200`

- CodeHealthReview
  - `file` object, required: Identity of the reviewed source file.
    - `path` string, required: Path of the file relative to the repository root.
  - `metrics` object, required: File-level metrics relevant to the Code Health review.
    - `linesOfCode` integer, required: Lines of code in the reviewed file.
    - `revisions` integer, required: Number of revisions to the reviewed file in the analysis period.
    - `coverage` object, nullable, required: Optional code coverage metric for the reviewed file.
      - `percent` number, required: Code coverage percentage for the reviewed file when available.
  - `codeHealth` object, required: Current Code Health score and historical trend for the reviewed file.
    - `score` number, required: Current Code Health score for the reviewed file.
    - `trend` object[], required: Historical Code Health observations for the reviewed file.
      - `date` string, required: Historical observation point for the file-level Code Health trend.
      - `score` number, required: Code Health score observed at this point in time.
  - `findings` object[], required: Code Health findings for the reviewed file.
    - `id` string, required: Stable identifier for the finding type.
    - `name` string, required: Human-readable finding name.
    - `description` string, required: Explanation of the Code Health issue or positive quality signal.
    - `severity` 'improvement' | 'warning' | 'problem', required: Severity classification for the finding.
    - `location` object: Source location associated with the finding when the finding is tied to a specific symbol.
      - `startLine` integer, required: First line of the source range associated with the finding.
      - `endLine` integer, required: Last line of the source range associated with the finding.
      - `symbol` string, required: Function or symbol name associated with the finding.
    - `recommendation` string, required: Recommended action or guidance for the finding.
  - `analysis` object, required: Metadata about the analysis that produced this review.
    - `date` string, date-time, required: ISO 8601 timestamp of the analysis that produced this review.

## Other responses

- `400`
- `401`
- `403`
- `404`

---

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