GET/v1/projects/{projectId}/analytics/annotation-coverage

Get Annotation Coverage

Returns how much of the project's API surface is covered by doc comments and @stx annotations — the same metric stx check reports locally.

Path Parameters

The project ID.

Example

curl https://api.syntext.dev/v1/projects/prj_abc123/analytics/annotation-coverage \
  -H "Authorization: Bearer stx_abc12345_..."

Response

{
  "data": {
    "totalSymbols": 248,
    "documentedSymbols": 189,
    "coveragePercent": 76,
    "undocumented": [
      { "name": "parseConfig", "file": "src/config.ts", "kind": "function" }
    ]
  }
}

Coverage is computed from the most recent successful build.

Enforce a minimum coverage threshold in CI with stx check — see the CI/CD guide.