PennyLens
Get Started

API Reference

An overview of the PennyLens analytics data model and what you can access in the dashboard.

What PennyLens captures

Each event in your account is stored with the following fields:

  • timestamp — UTC datetime the event was recorded
  • event_type — pageview, click, scroll, mousemove, form_*, or custom name
  • url — full URL the event occurred on
  • path — path portion of the URL (no query string)
  • session_id — unique ID grouping events from a single visit
  • visitor_id — persistent ID across sessions (first-party cookie)
  • device_type — desktop, tablet, or mobile
  • browser, os — user agent derived metadata
  • country, region — IP geolocation (IP is discarded after lookup)
  • properties — custom properties from PennyLens.track()

Dashboard features

  • Overview — KPIs (visitors, pageviews, sessions, bounce rate), traffic trend, top pages, referrers
  • Heatmaps — Click density, scroll depth, mouse movement, per-viewport
  • Sessions — Full replay with filters for duration, device, country, recording availability
  • Funnels — Conversion rate analysis across defined steps
  • Form Analytics — Per-field completion rate and drop-off
  • AI Insights — Automated pattern detection with AI-generated recommendations

CSV Export (Pro & Business)

Export data from any dashboard page as CSV. Paid plans include export for:

  • Events (raw, filtered by date range)
  • Sessions (metadata + duration)
  • Heatmap aggregates (per page)
  • AI Insights history

Webhooks (coming soon)

Real-time event webhooks and public REST API are on the roadmap.

Support