Get Content Health
Aggregate documentation health: overall score, weekly history, stale pages, gaps, and API coverage.
Returns an aggregate view of documentation health: an overall score and how it has moved week by week, pages that haven't been updated in 90+ days, documentation gaps detected from AI chat, and API coverage.
Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.
Path Parameters
projectIdResponse Fields
data.score0 when no page has been scored yet.data.stalePagesdata.gapssource is inferred for a question the assistant answered with low confidence, or reported for one a reader reported from the assistant. The full, paginated list is at List Gaps.data.coveragePercentdata.history[] until the first snapshot is taken.data.changenull with fewer than two weeks of history.data.since"October", for labels such as "+8 since October". null without history.data.sinceDateYYYY-MM-DD. null without history.history, change, since and sinceDate are optional — if the history cannot be read, all four are left out. See trend fields.
How the history is recorded
A snapshot is the average of the project's per-page scores on one day. Syntext rescores pages and takes a snapshot:
POST /analytics/health/computeThere is one snapshot per project per day; a later one that day replaces it. A project with no scored pages gets no snapshot, so it never shows a 0 it did not earn.
Per-page scores are available at GET /v1/projects/{projectId}/analytics/health.
Recompute content health
/v1/projects/{projectId}/analytics/health/computeRescores every page now and records today's snapshot. Same access as above: any member, any plan. No request body.
snapshot is null when the project has no scored pages yet, or when the snapshot could not be written. A recompute updates existing per-page scores rather than keeping the first score a page ever got.
If scoring fails, the endpoint returns 500 with code COMPUTE_FAILED.
Error Responses
401 Unauthorized
Missing, invalid or expired session JWT, or an API key.
403 Forbidden
You are not a member of the organization that owns the project.
404 Not Found
The project does not exist or has been deleted.