---
title: Get Annotation Coverage
protocol: rest
method: GET
endpoint: /v1/projects/{projectId}/analytics/annotation-coverage
description: "How much of your API surface is documented with annotations."
---

# 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`](/cli/check) reports locally.

<Endpoint method="GET" path="/v1/projects/{projectId}/analytics/annotation-coverage" />

## Path Parameters

<ParamField path="projectId" type="string" required>
  The project ID.
</ParamField>

## Example

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

### Response

```json
{
  "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.

<Note>
Enforce a minimum coverage threshold in CI with [`stx check`](/cli/check) — see the [CI/CD guide](/guides/ci-cd).
</Note>