Erfahren Sie, wie Sie das Tracker-Analytics-SDK von OpenReplay einrichten.

Das Analytics-SDK ist opt-in. Es wird nur instanziiert, wenn Sie analytics.active an den Tracker-Konstruktor übergeben – bis dahin ist tracker.analytics gleich null und tracker.track() tut nichts (No-Op).

import Tracker from '@openreplay/tracker'

const tracker = new Tracker({
  projectKey: "YOUR_PROJECT_KEY",
  analytics: { active: true },
})

tracker.start()

• active: boolean Schaltet das Analytics-SDK ein. Standard: false.
• ingestPoint?: string Endpunkt, an den Analytics-Batches gesendet werden. Nur für selbst gehostete Bereitstellungen – bei OpenReplay Cloud wird dies ignoriert und https://api.openreplay.com/ingest verwendet. Standardmäßig wird der ingestPoint des Trackers verwendet.

Weitere Informationen zur Verwaltung Ihrer Analytics-Daten in der OpenReplay-Oberfläche finden Sie unter Data Management.

// Identify a user with an id (e.g. email, username, etc.)
tracker.analytics.identify(userId: string): void
// same as
tracker.analytics.people.identify(userId)

// Add event to batch with option to send it immediately
tracker.analytics.track(eventName: string, tempProperties?: Record<string, any>, options?: { send_immediately: boolean })
// same as
tracker.analytics.events.track(eventName, tempProperties, options)

// Clear user id, people properties and super properties, and stop the batcher
tracker.analytics.reset(): void

Diese befinden sich direkt am Tracker, sodass Sie sie sicher aufrufen können, ohne auf tracker.analytics zuzugreifen (solange Analytics deaktiviert ist, tun sie nichts):

// Same as tracker.analytics.track(...)
tracker.track(eventName: string, properties?: Record<string, any>, options?: { send_immediately: boolean })

// Sets the replay's user ID *and* calls analytics.people.identify() with it
tracker.setUserID(id: string): void
tracker.identify(id: string): void // alias of setUserID

// Send analytics events under your own token, without session recording
tracker.setAnalyticsToken(token: string): void

Löscht den identifizierten Benutzer (einschließlich der persistenten Geräte-ID), alle People-Eigenschaften, alle Super Properties und stoppt den Batcher. Rufen Sie es beim Abmelden auf.

tracker.analytics.reset()

Wenn Probleme auftreten, verbinden Sie sich mit unserem Slack und holen Sie sich Hilfe von unserer Community.