Track

Track Views

To track screen views, pass an instance of TealiumView(tealiumEvent:dataLayer:) to the track() method. TealiumView consists of a view name, which appears in the tracking call as tealium_event, and an optional data dictionary.

Example

let screenView = TealiumView(
	"purchase",
	dataLayer: [
		"customer_id": "abc123", 
		"order_total": 10.00, 
		"product_id": ["PROD123", "PROD456"], 
		"order_id": "0123456789"
	]
)
tealium?.track(screenView)

Track Events

To track non-view events, pass an instance of TealiumEvent(tealiumEvent:dataLayer:) to the track() method. TealiumEvent consists of an event name, which appears in the tracking call as tealium_event, and an optional data dictionary.

Example

let tealEvent = TealiumEvent(
	"cart_add", 
	dataLayer: [
		"customer_id": "abc123", 
		"product_id": ["PROD123", "PROD456"], 
		"product_price": [4.00, 6.00]
	]
)
tealium?.track(tealEvent)

Timed Events

Timed events measure the duration of a single event or the time between two events. Timed events are triggered automatically or manually.

Automatic Triggers

Automatically track the duration between events by setting timedEventTriggers to a list of TimedEventTrigger objects, specifying the names of the start and stop events.

The following is an example of tracking a timed event with an automatic trigger:

config.timedEventTriggers = [TimedEventTrigger(
    start: "cart_add",
    stop: "purchase")]

Manual Triggers

Manually track the duration of an event by starting and stopping the timed event based on your custom logic.

Start tracking the duration of an event with startTimedEvent():

tealium.startTimedEvent(name: "TimeSpentViewingProduct")

Stop a timed event with stopTimedEvent():

tealium.stopTimedEvent(name: "TimeSpentViewingProduct")

Cancel a previously started timed event with cancelTimedEvent():

tealium.cancelTimedEvent(name: "TimeSpentViewingProduct")

Clear all previously started timed events with clearAllTimedEvents():

tealium?.clearAllTimedEvents()

Trace

Join Trace

The joinTrace() method joins a trace with the specified ID. Learn more about the Trace feature in the Tealium Customer Data Hub.

class TealiumHelper {
	var tealium: Tealium?
	// ...

	func joinTrace(traceId id: String) {
		tealium?.joinTrace(id: "TRACE_ID")
		// ...
	}
}

Replace TRACE_ID with the ID of the trace you want to join.

Leave trace

A trace remains active for the duration of the app session until the leaveTrace() method is called, which leaves a previously joined trace and ends the visitor session.

class TealiumHelper {
	var tealium: Tealium?
	// ...

	func leaveTrace() {
		tealium?.leaveTrace()
		// ...
	}
}

Connector actions set to run at "End of Visit" do not run until the session expires.

To preserve the trace visitor session when leaving the trace, pass the optional argument false, as shown in the following example:

tealium?.leaveTrace(killVisitorSession: false)