/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Guides Platform Insights

Insights

Traffic, search, assistant, feedback, content health, and API coverage analytics for your documentation.

5 min read

Every deployed doc site tracks usage automatically — no snippet to install, no cookie banners needed (tracking is anonymous by default). Open your project in the dashboard → Insights.

Insights has six tabs — Traffic · Search · Assistant · Feedback · Content health · API coverage — and one period control (24h, 7d, or 30d) that stays put as you switch tabs.

Note

Before Dashboard 2.0 these were separate pages: Analytics, Search insights, AI insights, Feedback, Content health, and Annotation coverage. Old links redirect to the matching tab.

Traffic

Insights › Traffic (the default tab).

•
Page views & visitors over time, compared with the previous period
•
Top pages — what people actually read
•
Referrers — where readers come from
•
Countries
•
Devices & engagement — device split, bounce rate and average time on page

How visitors move between pages is available through the Analytics API (navigation-flow); the dashboard doesn't show it.

Insights › Search.

•
Popular searches — what visitors look for most
•
Zero-result queries — searches that found nothing. This is your highest-signal backlog: people told you exactly what's missing. Each one has a Create page action.
•
Click-through — which results get clicked per query. Doc sites don't report search clicks yet, so this stays empty for now; the analytics beacon accepts a clickedResult if you send search events yourself

Assistant

Insights › Assistant. The AI assistant is an always-on user interview:

•
Questions per day, and how many answers came with sources
•
Answer confidence — the split between confident and low-confidence answers
•
Thumbs up/down feedback per answer, shown as Rated helpful by readers
•
Top topics — each topic's share of questions this period
•
Unanswered questions — questions the AI couldn't answer confidently, ranked by frequency. Each one is a page you should write — Draft page writes a first version from your existing pages and the questions people asked, which you review in the editor. The most-asked unanswered question also appears on your project's Overview.

Always up to date

The assistant's knowledge updates automatically on every production deploy — new and changed pages are picked up as part of the build, so answers always reflect your latest published content. No manual step required. (A retrain endpoint exists to force a full rebuild if you ever need one.)

Feedback

Insights › Feedback. Reader votes from the "Was this page helpful?" widget, as a helpful percentage per page — sort Worst first or Most rated, and jump to a page with Open in editor.

Content health

Insights › Content health. A 0–100 score per page and for the whole site, based on:

•
Freshness — pages untouched for 90+ days are flagged stale
•
Reader feedback — pages with negative "was this helpful?" ratios
•
Links — broken links
•
Annotation coverage — % of your public API symbols that are documented (details)

The Gaps panel lists topics readers want but you haven't written, most asked first, each with Draft page. Choose Reported by readers to see only the gaps readers reported from agent mode; those carry a Reported badge under All.

Pages that go stale also show on Workflow › Ownership, which can email their owners and post to Slack every Monday — see Stale-page alerts.

API coverage

Insights › API coverage (formerly Annotation coverage) shows how many of your API endpoints carry @stx documentation, broken down by resource (lowest coverage first), with a ready-to-paste @stx stub for an undocumented endpoint.

DX funnel

For API-first products, Syntext tracks the developer journey: docs visit → API playground usage → first successful API call, including time-to-first-call — the metric that predicts activation. It's available through the Analytics API (dx-funnel, time-to-first-call) and isn't shown in the dashboard.

Programmatic access

Everything above is queryable via the Analytics API for custom reports and BI exports.

What counts as a page view

A page view is recorded when a reader opens a page — the first page of a visit, and every page after it, including pages that open in place on doc engine v2 sites. Each page view counts once in every Insights number — page views, visitors, top pages, referrers, countries and devices. Time on page and bounce rate are measured when the reader leaves the page. A bounce is a visit that left within 10 seconds without opening another page. A page left open for more than 30 minutes doesn't count toward time on page. Jumping to a heading on the same page isn't a new view. On doc engine v2 sites, neither is going Back or Forward to a page counted less than a second earlier.

•
Previews — on doc engine v2 sites, branch and pull request previews don't record page views, so preview traffic stays out of your production numbers.
•
The Ask page — visits to the full-page assistant at /ask count as page views of /ask, on every site. A shared conversation counts as /ask/s. The questions asked there are counted under Assistant as well.
•
Not counted — the 404 page.

Global Privacy Control and Do Not Track

When a visitor's browser sends Global Privacy Control or Do Not Track, their page views are still counted, but anonymously:

•
They appear in page views, top pages, countries, devices, time on page and bounce rate.
•
They aren't included in visitors (unique visitors), so your visitor count can be lower than the number of people reading.
•
Nothing about them is stored in their browser, their visits aren't linked from page to page, and their referrer isn't recorded. Their pages don't appear in navigation flow or the DX funnel, and their searches and playground calls are counted without a visitor.

This works the same on doc engine v1 and v2 sites, with nothing to configure.

Note

Tracking beacons return 202 and never block page rendering.

Was this page helpful? Yes No
Previous
Product
Resources
Company
© 2026 SyntextBuilt with Syntext