Analytics Setup
Use documentation analytics to see which pages help users reach trial signup, request demo, or API activation. Do not use analytics in a way that exposes customer spectral data, report content, or regulated records.
Events
Section titled “Events”| Event | Trigger | Required properties |
|---|---|---|
page_view | Every docs page load. | path, title, section, referrer. |
cta_click | Request Demo, Start Trial, Contact Sales, or API key CTA click. | path, cta_label, destination. |
docs_search | Search query submitted. | query, path, result_count when available. |
trial_signup_started | User begins signup from docs or website. | source_path, utm_source, utm_campaign. |
trial_signup_completed | Signup completes. | source_path, workspace_id or anonymous account id. |
Funnel
Section titled “Funnel”Create this funnel in PostHog:
page_viewon any docs page.cta_clickon a trial, demo, or signup CTA.trial_signup_started.trial_signup_completed.
Review monthly:
- Pages with high exits should be rewritten first.
- Pages that correlate with trial signup should be promoted in navigation and CTAs.
- Search terms with no results should become new docs tasks.
Starlight implementation note
Section titled “Starlight implementation note”The source guide used a Mintlify analytics block. In this Starlight site, add the PostHog script only after the privacy policy, cookie/consent approach, and production project key are approved. Keep the API key in environment configuration where possible, and never capture spectral filenames, project names, raw FID data, or report content.