Skip to content

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.

EventTriggerRequired properties
page_viewEvery docs page load.path, title, section, referrer.
cta_clickRequest Demo, Start Trial, Contact Sales, or API key CTA click.path, cta_label, destination.
docs_searchSearch query submitted.query, path, result_count when available.
trial_signup_startedUser begins signup from docs or website.source_path, utm_source, utm_campaign.
trial_signup_completedSignup completes.source_path, workspace_id or anonymous account id.

Create this funnel in PostHog:

  1. page_view on any docs page.
  2. cta_click on a trial, demo, or signup CTA.
  3. trial_signup_started.
  4. 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.

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.