trackingEvent

Description

Observable field that emits an analytics event whenever a user-facing SDK event occurs, including panel interactions and overlay lifecycle events.

Type

assocArray

Usage

m.lib.observeField("trackingEvent", "onTrackingEvent")

function onTrackingEvent(event as Object)
    trackingData = event.getData()
    if trackingData <> invalid
        ' Forward to your analytics service
        yourAnalyticsService.track(trackingData)
    end if
end function

Overlay Events

The trackingEvent field fires for the full overlay lifecycle. Three event types are emitted for all overlay types:

Event type	When it fires
view	The overlay becomes visible on screen
engage	The user selects the overlay and the associated panel opens
dismiss	The overlay is automatically dismissed after its display period expires

Example

sub setupTrackingObserver()
    m.lib.observeField("trackingEvent", "onTrackingEvent")
end sub

function onTrackingEvent(event as Object)
    trackingData = event.getData()
    if trackingData <> invalid
        ' Forward to your analytics service
        yourAnalyticsService.track(trackingData)
    end if
end function

Best Practices

• Set up the trackingEvent observer before setting the SDK config so no events are missed.
• Forward the full tracking payload to your analytics platform rather than extracting individual fields.
• Implement proper error handling in case trackingData is invalid.

Related

• userViewedPanel
• panelOpenedThroughOverlay