SDK de Analytics do tracker
SDK de Analytics
Section titled SDK de AnalyticsSaiba como configurar o SDK de analytics do tracker do OpenReplay.
Habilitando o SDK
Section titled Habilitando o SDKO SDK de analytics é opt-in. Ele só é instanciado quando você passa analytics.active ao construtor do tracker — até lá, tracker.analytics é null e tracker.track() não faz nada (no-op).
import Tracker from '@openreplay/tracker'
const tracker = new Tracker({
projectKey: "YOUR_PROJECT_KEY",
analytics: { active: true },
})
tracker.start()
Opções
Section titled Opçõesactive: booleanAtiva o SDK de analytics. Padrão:false.ingestPoint?: stringEndpoint para o qual os lotes de analytics são enviados. Apenas para implantações auto-hospedadas — no OpenReplay Cloud, isso é ignorado ehttps://api.openreplay.com/ingesté usado. Por padrão, usa oingestPointdo tracker.
Módulos
Section titled MódulosPara saber mais sobre como gerenciar seus dados de analytics na interface do OpenReplay, acesse Data Management.
Assinaturas de nível superior
Section titled Assinaturas de nível superior// 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
Atalhos no nível do tracker
Section titled Atalhos no nível do trackerEles ficam no próprio tracker, então é seguro chamá-los sem acessar tracker.analytics (eles não fazem nada enquanto o analytics estiver desabilitado):
// 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
reset
Section titled resetLimpa o usuário identificado (incluindo o ID persistente do dispositivo), todas as propriedades de people, todas as super properties e interrompe o batcher. Chame-o no logout.
tracker.analytics.reset()
Tem dúvidas?
Section titled Tem dúvidas?Se você encontrar algum problema, conecte-se ao nosso Slack e peça ajuda à nossa comunidade.