Questo modulo ti permette di gestire eventi e proprietà: coppie chiave/valore persistenti che vengono allegate automaticamente a ogni evento tracciato.

Le super properties vengono memorizzate localmente e unite al payload di ogni evento quando tracci gli eventi.

Per saperne di più sulla gestione degli eventi nell’interfaccia di OpenReplay, visita Gestione dei dati.

Disponibile in:

tracker.analytics.events

Le super properties vengono memorizzate nello SDK e unite a ogni evento sotto properties.

Le proprietà dell’evento vengono passate solo per una singola chiamata a track/sendEvent e non vengono salvate come super properties.

Vengono rifiutati due insiemi diversi di chiavi, a seconda dell’helper:

Proprietà predefinite — raccolte dallo SDK stesso e inviate con ogni evento. setProperty le ignora silenziosamente, quindi non puoi sovrascriverle con una super property:

os, os_version, browser, browser_version, platform, screen_height, screen_width, initial_referrer, utm_source, utm_medium, utm_campaign, user_id, distinct_id, sdk_edition, sdk_version, timezone, search_engine

Chiavi del payload — properties, token e timestamp. Fanno parte dell’envelope dell’evento, quindi setPropertiesOnce e unsetProperties le ignorano.

// Track an event.
// The `properties` argument is per-event only (not persisted).
tracker.analytics.events.sendEvent(eventName: string, properties?: Record<string, any>, options?: { send_immediately: boolean })

// Create/update super properties (persisted)
tracker.analytics.events.setProperty(name: string, value: any): void
tracker.analytics.events.setProperty(properties: Record<string, any>): void

// Create super properties only if they don't exist yet (persisted)
tracker.analytics.events.setPropertiesOnce(name: string, value: any): void
tracker.analytics.events.setPropertiesOnce(properties: Record<string, any>): void

// Remove super properties (persisted)
tracker.analytics.events.unsetProperties(name: string): void
tracker.analytics.events.unsetProperties(names: string[]): void

// Clear all super properties
tracker.analytics.events.reset(): void

tracker.analytics.events.sendEvent("Button Clicked", {
  button_text: "Start",
  page: "home",
})

Queste proprietà si applicano solo a questo evento.

Quando imposti le super properties, queste vengono incluse automaticamente in ogni evento e poi unite alle proprietà per singolo evento:

tracker.analytics.events.setProperty({
  app_version: "1.42.0",
  env: "prod",
})

tracker.analytics.events.sendEvent("Signup Started", {
	// per-event, can override a super property with the same key
  plan: "pro", 
})

Ordine di unione:

• prima vengono aggiunte le super properties
• poi vengono unite, sopra di esse, le proprietà per singolo evento

Quindi, in caso di conflitto tra chiavi, prevalgono le proprietà per singolo evento.

Crea o sovrascrive le super properties.

// object form
tracker.analytics.events.setProperty({
  app_version: "1.42.0",
  region: "eu",
})

// key/value form
tracker.analytics.events.setProperty("build_sha", "3f2c9a1")

• Le proprietà predefinite raccolte dallo SDK vengono ignorate e non verranno aggiunte come super properties.
• La forma chiave/valore viene ignorata quando value è undefined; passa null per memorizzare un valore vuoto.
• Le modifiche vengono salvate localmente solo se qualcosa è effettivamente cambiato.

Crea le super properties solo se non esistono ancora.

tracker.analytics.events.setPropertiesOnce({
  first_seen_at: Date.now(),
  signup_source: "docs",
})

// key/value form
tracker.analytics.events.setPropertiesOnce("initial_referrer", document.referrer)

• Le proprietà vengono impostate solo se la chiave è assente.
• Le chiavi riservate (properties, token, timestamp) vengono ignorate.

Rimuove una o più super properties.

// single
tracker.analytics.events.unsetProperties("region")

// multiple
tracker.analytics.events.unsetProperties(["app_version", "build_sha"])

• Le chiavi riservate non possono essere rimosse.
• La rimozione è persistente.

Cancella tutte le super properties.

tracker.analytics.events.reset()

Per impostazione predefinita, gli eventi vengono messi in coda e raggruppati in batch. Puoi richiedere l’invio immediato di un evento:

tracker.analytics.events.sendEvent(
  "Checkout Completed",
  { value: 199, currency: "EUR" },
  { send_immediately: true },
)

Tutti i metodi supportano un livello di compatibilità, offerto per garantire un’interfaccia familiare:

tracker.analytics.events.register       // setProperty
tracker.analytics.events.register_once  // setPropertiesOnce
tracker.analytics.events.unregister     // unsetProperties
tracker.analytics.events.track          // sendEvent

Se riscontri problemi, collegati al nostro Slack e chiedi aiuto alla nostra community.