quality

Returns the file inventory narrowed to the files a component owns.

Changed on
get/api/projects/{project-id}/components/{component-id}/quality/files/inventory

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}/components/{component-id}/quality/files/inventory
  • Auth: none declared

Path parameters

project-idinteger required
component-idinteger required

Query parameters

pageSizeinteger

Number of data points to return per page. Defaults to 100.

pageTokenstring

Opaque cursor returned as nextPageToken in a previous response. Resumes pagination from where the previous page ended. pageSize may differ from the original request.

sortstring

Sort results by a property. Format: property or property:asc / property:desc. Valid sort properties depend on the endpoint.

Response

OR

Example response

{
  "asOf": "2026-06-09T10:15:00Z",
  "files": [
    {
      "path": "my-repo/src/uplift-target.cs",
      "parentPath": "my-repo/src",
      "component": "Payments",
      "changeFrequency": 35,
      "linesOfCode": 500,
      "codeHealth": {
        "value": 3,
        "classification": "unhealthy-code"
      },
      "isHotspot": true,
      "upliftTarget": {
        "isTarget": true,
        "type": "primary"
      },
      "knowledge": {
        "mainAuthor": {
          "name": "Bob",
          "ownership": 0.75,
          "linesAdded": 300,
          "isActive": true
        },
        "authorCount": 2,
        "contributors": [
          {
            "name": "Alice",
            "ownership": 0.25,
            "isActive": true
          }
        ]
      },
      "team": {
        "mainTeam": {
          "name": "team-core",
          "ownership": 1
        },
        "authorCount": 1
      },
      "lastModified": {
        "date": "2026-04-03",
        "ageMonths": 2
      },
      "offboardingRisk": {
        "isRisk": true
      },
      "coupling": [
        {
          "path": "my-repo/test/uplift-target-test.cs",
          "couplingPercent": 85,
          "averageChangeFrequency": 12,
          "component": "Payments"
        }
      ]
    }
  ],
  "summary": {
    "totalFiles": 3,
    "hotspotCount": 2,
    "upliftTargetCount": 1,
    "healthyHotspotCount": 1,
    "offboardingRiskCount": 1
  },
  "nextPageToken": "eyJwYWdlTmJyIjoxLCJwYWdlU2l6ZSI6NTB9"
}

Changes