quality

Returns per-component change frequency, code health, knowledge, and counts of hotspots, uplift targets, and off-boarding risks, plus a summary of files that match no component.

get/api/projects/{project-id}/quality/components/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}/quality/components/inventory
  • Auth: none declared

Path parameters

project-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

projectIdinteger required

Identifier of the project.

asOfstring date-time required

ISO 8601 datetime of when the snapshot was taken.

nextPageTokenstring

Opaque cursor for the next page. Absent on the last page or when all results fit in one page.

Example response

{
  "projectId": 1,
  "asOf": "2026-06-09T10:15:00Z",
  "components": [
    {
      "name": "Payments",
      "changeFrequency": 70,
      "linesOfCode": 600,
      "averageCodeHealth": {
        "value": 6,
        "classification": "problematic-code",
        "trend": {
          "direction": "steady"
        }
      },
      "hotspotCodeHealth": {
        "value": 6,
        "classification": "problematic-code",
        "trend": {
          "direction": "steady"
        }
      },
      "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
      },
      "fileCount": 2,
      "hotspots": 2,
      "upliftTargets": 1,
      "offboardingRisks": 1
    }
  ],
  "summary": {
    "totalComponents": 2,
    "hotspots": 2,
    "upliftTargets": 1,
    "offboardingRisks": 1,
    "unmappedFiles": {
      "fileCount": 1,
      "topFolders": [
        {
          "path": "payments-service/src",
          "fileCount": 1
        }
      ]
    }
  },
  "nextPageToken": "eyJwYWdlTmJyIjoxLCJwYWdlU2l6ZSI6NTB9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.