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-idinteger required

Query parameters

pathstring required

Repo-scoped relative file path to retrieve the Code Health review for.

Response

Example response

{
  "file": {
    "path": "aspnetcore/src/Http/Http.Extensions/src/RequestDelegateFactory.cs"
  },
  "metrics": {
    "linesOfCode": 1842,
    "revisions": 73,
    "coverage": {
      "percent": 82.4
    }
  },
  "codeHealth": {
    "score": 7.6,
    "trend": [
      {
        "date": "2026-04-14",
        "score": 8.1
      },
      {
        "date": "2026-06-03",
        "score": 7.9
      },
      {
        "date": "2026-09-01",
        "score": 7.6
      }
    ]
  },
  "findings": [
    {
      "id": "complex-method",
      "name": "Complex Method",
      "description": "The method contains multiple conditional paths that increase the cognitive load required to understand it.",
      "severity": "warning",
      "location": {
        "startLine": 412,
        "endLine": 487,
        "symbol": "CreateArgument"
      },
      "recommendation": "Decompose the method into smaller functions that represent distinct responsibilities."
    }
  ],
  "analysis": {
    "date": "2026-09-01T14:32:18Z"
  }
}

Changes