Skip to main content

APIs and client-side framework

APIs and client-side framework

Track session type

There are three sample events to identify sessions that originate from a Tealeaf client framework-enabled application. Two are provided by Tealeaf and one you create.

This table summarizes events that you can use to identify sessions that originate from a client framework-enabled application:

Table 1. Tracking type of session
client framework submitted data type HTTP_X_ TEALEAF value Detected value Capturing event
UIC for XML XML ClientEvent ClientEvent CUI Hit
UIC for JSON JSON 
device (UIC) 
Lib/2012.06.
01.1.JS
 UIC You must create an event.
Android JSON 
device (Android) 
Lib/0.0.10
 Android Mobile Device
iOS JSON 
device (iOS) 
Lib/8.5.4.1
 iOS Mobile Device

Creating a session attribute to track session type across events

To track the type of session across all of your events, create a session attribute.

Call the attribute CUI Session Type.

  1. In the Event Manager, click the Session Attributes tab.
  2. Click New Session Attribute.
  3. Define the key properties:
    • Name: Use CUI Session Type or similar.
    • Description: Enter something similar to the following: Source of session if it is captured from the client using a client framework.
    • Populated By: Select one of the events that you created.
  4. Click Save Draft.

The session attribute is saved.

Editing events to update the session tracking attribute

Modify the events that you want to update the session tracking attribute. If you want mobile session events to update this attribute.

  1. Click the Events tab.
  2. Right-click one of the events you created and select Edit Event.
  3. Add the attribute you created to the lists of attributes that this event updates:
    1. Click the More Options tab.
    2. To Update Session Attribute, click Select.
    3. Select the session attribute that you just created.
    4. Click Save Draft.
  4. Repeat these steps for the other events you created, for example the mobile event.
  5. To save all changes, click Save Changes.

When the created events are triggered, they record the value of the event, which is the identifier for the type of CUI session, to the session attribute.

Adding a dimension to be sourced from session attribute

Whenever an event is triggered, the session attribute is updated, and any dimensions associated with the event are updated. A dimension is a piece of contextual information that is recorded when an event fires. You can use dimensions to create reporting filters to segment reporting along the type of client framework session.

Because the events are populated only with values that are defined by the Tealeaf client frameworks, you create the whitelist to capture these values. These values should be the same as those recorded for the HTTP_X_TEALEAF request variable.

  1. Click the Dimensions tab.
  2. Click New Dimension.
  3. For the Populated By option, select the session attribute you created.
  4. Click the Advanced Options caret.
  5. For Values to Record, select Whitelist Only.
  6. Click Edit Whitelist?
  7. Specify the values in the whitelist.
  8. Save the whitelist.
  9. Populate the other dimension properties as needed.
  10. Save the dimension as a draft.
  11. Save changes to the server.

This dimension can be associated with other events to segment reporting along the type of client framework session.

Related articles

community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more