OrbitDocs packages are coming to npm soon. Until then, run it from the GitHub repo →
Self-hosted platform

Analytics

Count page views without cookies, or send them to Plausible, Umami or PostHog, and see what readers ask Ask AI.

Every site the platform hosts can report traffic. Built-in analytics need no setup and set no cookies. You can send page views to Plausible, Umami or PostHog instead. Ask AI questions are always counted in the platform, so you can see what the docs don't answer.

Pick a provider

Open the project, Settings → General → Analytics (admin role), pick a provider and select Save:

ProviderSite idHost (optional)
Built-in (default)nonenone
PlausibleYour site's domain, such as docs.acme.comSelf-hosted Plausible URL. Default https://plausible.io.
UmamiThe website IDSelf-hosted Umami URL. Default https://cloud.umami.is.
PostHogThe project API keyPostHog host. Default https://us.i.posthog.com.

The platform adds the provider's script to every HTML page when it serves it. Nothing in your build changes, and switching providers takes effect on the next page load.

Built-in analytics

The built-in option adds a small script, /_orbit/a.js, that sends a page view to /_orbit/e on every page change. It uses navigator.sendBeacon and sets no cookies.

  • Visitors are counted by a hash of the day, the IP address and the browser's user agent, salted with PLATFORM_SECRET. The raw IP is never stored, and the hash changes every day, so readers can't be followed across days.
  • Referrers only count other sites. Links inside the docs are not referrers.
  • Page views on previews are counted too, under the same project.

The Analytics tab

Pick 7, 30 or 90 days. The tab shows:

PanelWhat it shows
Page views, VisitorsTotals for the period (built-in only).
Ask AI questionsQuestions asked in the period.
Not covered by docsQuestions whose answer found no source in the docs.
TrafficViews and visitors per day.
Top pagesThe 10 most viewed paths.
ReferrersThe 10 sites that sent the most readers.
What readers askThe 20 most recent questions, with how many sources each answer used.

With Plausible, Umami or PostHog, page views go to that tool and these panels stay empty. The Ask AI panels keep working.

Use 'Not covered by docs' as a to-do list

A question with zero sources means search found nothing relevant. Write the missing guide, then watch the count drop.

Ask AI questions

Questions are recorded only for sites with Ask AI (ai in orbitdocs.config.ts). The first 500 characters of each question are stored with its source count. The same daily visitor hash is stored; the answer is not.

API

Viewers can read the same numbers as JSON:

curl -b od_platform=… "https://docs.acme.com/api/projects/payments/analytics?days=30"

days is 1 to 365 (default 30). The response has provider, totals, series (one entry per day, zeros filled in), pages, referrers and questions.

Next steps

Last updated on

On this page