@plushanalytics/web

Browser SDK for Plush Analytics (events + session replay).

Install

npm install @plushanalytics/web

Quick Setup

import { createPlushWebClient } from "@plushanalytics/web";

const analytics = createPlushWebClient({
  apiKey: "plsh_...",
  projectId: "web-app"
});

await analytics.track("page_view", { context: { path: location.pathname } });
await analytics.startSessionRecording();

Common Usage

await analytics.track("checkout_started", {
  properties: { plan: "pro" },
  context: { route: "/checkout" }
});

await analytics.identify("user_123", { traits: { plan: "pro" } });
await analytics.screen("Pricing");
await analytics.group("org_456", { traits: { tier: "enterprise" } });

analytics.setContext({ abTest: "pricing_v2" });

Replay Lifecycle

await analytics.startSessionRecording();
await analytics.flushSessionRecording();
await analytics.stopSessionRecording();

// aliases
await analytics.startReplay();
await analytics.flushReplay();
await analytics.stopReplay();

API Surface

• createPlushWebClient(config)
• track(eventName, options?)
• identify(userId, options?)
• screen(screenName, options?)
• group(groupId, options?)
• flushEvents()
• startSessionRecording(options?) / startReplay(options?)
• flushSessionRecording() / flushReplay()
• stopSessionRecording() / stopReplay()
• setContext(context)
• shutdown()

Also Exported: createPlushAnalyticsClient(config)

Use this when you want the core client directly from the web package.