SDK d'analyse du tracker

Découvrez comment configurer et utiliser le SDK d'analyse du tracker OpenReplay

SDK d'analyse du tracker

Découvrez comment configurer le SDK d’analyse du tracker OpenReplay.

Le SDK d’analyse est optionnel (opt-in). Il n’est instancié que lorsque vous passez analytics.active au constructeur du tracker ; jusque-là, tracker.analytics vaut null et tracker.track() n’a aucun effet.

import Tracker from '@openreplay/tracker'

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

tracker.start()
  • active: boolean Active le SDK d’analyse. Par défaut : false.
  • ingestPoint?: string Point de terminaison auquel les lots d’analyse sont envoyés. Uniquement pour les déploiements auto-hébergés : sur OpenReplay Cloud, cette option est ignorée et https://api.openreplay.com/ingest est utilisé. Par défaut, la valeur de ingestPoint du tracker.

Pour en savoir plus sur la gestion de vos données d’analyse dans l’interface d’OpenReplay, consultez Gestion des données.

// 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

Raccourcis au niveau du tracker

Section titled Raccourcis au niveau du tracker

Ces méthodes se trouvent sur le tracker lui-même : vous pouvez donc les appeler sans risque sans passer par tracker.analytics (elles n’ont aucun effet tant que l’analyse est désactivée) :

// 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

Efface l’utilisateur identifié (y compris l’identifiant persistant de l’appareil), toutes les propriétés people, toutes les super propriétés, et arrête le batcher. Appelez-la lors de la déconnexion.

tracker.analytics.reset()

Si vous rencontrez des problèmes, rejoignez notre Slack ou consultez notre Forum et obtenez de l’aide auprès de notre communauté.