Documentation

Getting Started

Platform Features

Platform Features

Understand what you can track and analyze right out of the box with zero configuration.


Core Tracking

  • Pageviews & Unique Visitors: Total page views, visits, and unique visitors are tracked automatically. All data is anonymized — no cookies required for basic tracking.
  • Bounce Rate: Automatically calculated for sessions where the user viewed only one page.
  • Average Visit Duration: Measured via a heartbeat signal sent every 30 seconds while the page is visible.

Referrers & UTM Tags

The script automatically parses UTM tags (utm_source, utm_medium, utm_campaign, utm_term, utm_content) and HTTP referer strings. It also supports the short aliases ref, source, and via.

Custom Event Tracking

Track any user interaction by adding a data-ezlytics-goal attribute to an element, or by calling the JS API for programmatic events.

HTML
<!-- HTML attribute approach (simplest) -->
<button data-ezlytics-goal="signup-clicked">Sign Up</button>

<!-- With extra metadata (max 10 properties) -->
<button
  data-ezlytics-goal="upgrade-clicked"
  data-ezlytics-goal-plan="pro"
  data-ezlytics-goal-source="banner"
>
  Upgrade
</button>

Scroll Depth Tracking

Fire events when users scroll to specific sections using the data-ezlytics-scroll attribute. Uses IntersectionObserver under the hood — no performance impact.

HTML
<section
  data-ezlytics-scroll="reached-pricing"
  data-ezlytics-scroll-threshold="0.5"
  data-ezlytics-scroll-delay="500"
>
  <h2>Pricing</h2>
</section>

User Identification

Associate events with a specific logged-in user using the identify command. This links all future events in that session to the user.

JavaScript
window.ezlytics("identify", {
  user_id: "user_abc123",  // required
  name: "Jane Doe",        // optional
  plan: "pro",             // any extra keys become metadata
  company: "Acme Inc",
});

Funnel Analysis

Define a sequence of custom events (e.g., "Visited Pricing" → "Clicked Signup" → "Completed Registration") to visualize drop-off rates at each step. Access this from the Funnels tab on your dashboard.

Revenue Tracking

Revenue events are captured automatically via webhook integration (e.g., LemonSqueezy). Your revenue dashboard is updated in real time and broken down by traffic source, UTM campaign, and referrer.

Script Configuration Options

The script supports several optional attributes for advanced setups:

AttributeEffect
data-allow-localhostEnable tracking on localhost (useful during development)
data-disable-consoleSuppress all [Ezlytics] console warnings
data-allowed-hostnamesWhitelist specific hostnames (comma-separated)
data-api-urlOverride the tracking endpoint URL (for self-hosted setups)
data-allow-file-protocolEnable tracking on file:// pages

🔒 Do Not Track

The script automatically respects the browser's navigator.doNotTrack flag. If a visitor has DNT enabled, all tracking is silently disabled — no data is sent.