Eventos

Define y gestiona super propiedades para los eventos de analítica del tracker de OpenReplay.

Eventos

Este módulo te permite gestionar eventos y propiedades — pares clave/valor persistentes que se adjuntan automáticamente a cada evento rastreado.

Las super propiedades se almacenan localmente y se fusionan en el payload de cada evento cuando rastreas eventos.

Para obtener más información sobre la gestión de eventos en la interfaz de OpenReplay, visita Data Management.

Disponible en:

tracker.analytics.events

Las super propiedades se almacenan en el SDK y se fusionan en cada evento bajo properties.

Las propiedades de evento se pasan únicamente en una sola llamada a track/sendEvent y no se guardan como super propiedades.

Estas claves están reservadas y no se pueden crear/eliminar mediante los helpers de super propiedades:

  • properties
  • token
  • timestamp
// 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

Rastrear eventos con propiedades

Section titled Rastrear eventos con propiedades

Propiedades por evento (no persistentes)

Section titled Propiedades por evento (no persistentes)
tracker.analytics.events.sendEvent("Button Clicked", {
  button_text: "Start",
  page: "home",
})

Estas propiedades se aplican únicamente a este evento.

Super propiedades + propiedades por evento (fusionadas)

Section titled Super propiedades + propiedades por evento (fusionadas)

Cuando estableces super propiedades, se incluyen automáticamente en cada evento y luego se fusionan con las propiedades por 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", 
})

Orden de fusión:

  • las super propiedades se añaden primero
  • las propiedades por evento se fusionan encima

Por lo tanto, las propiedades por evento prevalecen en caso de colisión de claves.

Crea o sobrescribe super propiedades.

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

// key/value form
tracker.analytics.events.setProperty("build_sha", "3f2c9a1")
  • Las claves predeterminadas/internas (rastreadas por el SDK) se ignoran y no se añadirán como super propiedades.
  • Los cambios se guardan localmente solo si algo cambió realmente.

Crea super propiedades solo si aún no existen.

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

// key/value form
tracker.analytics.events.setPropertiesOnce("initial_referrer", document.referrer)
  • Las propiedades solo se establecen si la clave no existe.
  • Las claves reservadas (properties, token, timestamp) se ignoran.

Elimina una o más super propiedades.

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

// multiple
tracker.analytics.events.unsetProperties(["app_version", "build_sha"])
  • Las claves reservadas no se pueden eliminar.
  • La eliminación se persiste.

Borra todas las super propiedades.

tracker.analytics.events.reset()

De forma predeterminada, los eventos se encolan/agrupan en lotes. Puedes solicitar un envío inmediato de un evento:

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

Alias compatibles con Mixpanel

Section titled Alias compatibles con Mixpanel

Todos los métodos admiten una capa de compatibilidad proporcionada para mayor familiaridad:

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

Si encuentras algún problema, conéctate a nuestro Slack o consulta nuestro Foro y obtén ayuda de nuestra comunidad.