Quick Start

Prerequisites

• A running instance of Harshit Metrics (or use the hosted version at metrics.harshit.page)
• Node.js 18+ for SDK usage
• A project with an API key (see Your First Project)

1. Install the SDK

npm install harshit-metrics

2. Initialize the client

Create a singleton client in your app:

import { createMetricsClient } from "harshit-metrics";

export const metrics = createMetricsClient("mtr_your_api_key_here", {
  endpoint: "https://metrics.harshit.page/api/collect",
  autoTrackPageviews: true,
});

3. Track custom events

metrics.track("button_clicked", {
  metadata: {
    buttonId: "hero-cta",
    variant: "blue",
  },
});

4. View your data

Open the Dashboard, select your project, and watch events flow in. The dashboard shows:

• Traffic timeline — events and pageviews over time
• Top pages — most visited paths
• Top referrers — where your traffic comes from
• Browser & device breakdown — visitor technology distribution
• Custom events — your tracked business events
• Live visitors — real-time active user count

Next steps

• Installation details — all install methods and environments
• SDK Configuration — fine-tune batching, retries, and auto-tracking
• Auto-tracking — enable click, scroll, error, and web vitals tracking