API

Get Content Health

Returns an aggregate view of documentation health: an overall score, pages that haven't been updated in 90+ days, documentation gaps detected from AI chat, and API coverage.

GET/v1/projects/{projectId}/analytics/content-health

Path Parameters

The project ID.

Example

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

Response

{
  "data": {
    "score": 82,
    "stalePages": [
      {
        "path": "/guides/legacy-setup",
        "lastUpdated": "2026-02-10T08:00:00Z"
      }
    ],
    "gaps": [
      {
        "topic": "webhook retry behavior",
        "source": "ai_chat",
        "frequency": 14
      }
    ],
    "coveragePercent": 76
  }
}

Response Fields

Overall content health, 0–100. The average of per-page health scores (freshness, feedback, broken links, completeness).

Pages not updated in more than 90 days.

Topics visitors asked the AI assistant about that the docs don't cover well, with how often each came up.

Percentage of public API symbols that have documentation.

Per-page scores are available at GET /v1/projects/{projectId}/analytics/health.

Was this page helpful?