Skip to main content

APIs and client-side framework

APIs and client-side framework

Default client framework objects

Each client framework has a default set of JSON objects. The objects map to System Step Attributes provided by Tealeaf.

Data sources for JSON objects

This table maps JSON attributes submitted by one or more client frameworks to the System Step Attributes provided by Tealeaf. These attributes are available in the System Step Attributes label in the Hit Attributes tab of the Event Manager.

Table 1. Default Client Framework Objects
Step Attribute Path UIC(j2) cxOverstat (only) iOS Android 
.messageVersion
 Y   Y Y 
.serialNumber
 Y   Y Y 
.sessions[0].clientEnvironment.
osVersion
     Y Y 
.sessions[0].clientEnvironment.
height
     Y Y 
.sessions[0].clientEnvironment.
width
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.appName
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.totalMemory
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.totalStorage
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.orientationType
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.appVersion
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.manufacturer
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.userId
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.locale
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.deviceModel
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.language
     Y Y 
.sessions[0].clientEnvironment.
mobileEnvironment.android.brand
       Y 
.sessions[0].clientEnvironment.
mobileEnvironment.android.
fingerPrint
       Y 
.sessions[0].clientEnvironment.
mobileEnvironment.android.
keyboardType
       Y 
.sessions[0].clientEnvironment.
webEnvironment.libVersion
 Y       
.sessions[0].clientEnvironment.
webEnvironment.page
 Y       
.sessions[0].clientEnvironment.
webEnvironment.screen.orientation
 Y       
.sessions[0].clientEnvironment.
webEnvironment.screen.
orientationMode
 Y       
.sessions[0].id
 Y       
.sessions[0].message.
clientState.event
 Y       
.sessions[0].message.
clientState.pageHeight
 Y Y     
.sessions[0].message.
clientState.pageWidth
 Y Y     
.sessions[0].message.
clientState.viewPortHeight
 Y       
.sessions[0].message.
clientState.viewPortWidth
 Y       
.sessions[0].message.
clientState.viewPortX
 Y       
.sessions[0].message.
clientState.viewPortXStart
 Y       
.sessions[0].message.
clientState.viewPortY
 Y       
.sessions[0].message.
clientState.viewPortYStart
 Y       
.sessions[0].message.
clientState.viewTime
 Y       
.sessions[0].message.
connection.description
     Y Y 
.sessions[0].message.
connection.initTime
     Y Y 
.sessions[0].message.
connection.loadTime
     Y Y 
.sessions[0].message.
connection.responseDataSize
     Y Y 
.sessions[0].message.
connection.responseTime
     Y Y 
.sessions[0].message.
connection.statusCode
     Y Y 
.sessions[0].message.
connection.url
     Y Y 
.sessions[0].message.count
 Y       
.sessions[0].message.
customEvent.name
 Y   Y Y 
.sessions[0].message.
customEvent.
data.[property based on 
custom event]
 Y   Y Y 
.sessions[0].message.
event.tlEvent
 Y   Y Y 
.sessions[0].message.
event.type
 Y   Y Y 
.sessions[0].message.
event.subType
 Y   Y Y 
.sessions[0].message.
exception.description
 Y   Y Y 
.sessions[0].message.
exception.line
 Y       
.sessions[0].message.
exception.name
     Y Y 
.sessions[0].message.
exception.stackTrace
     Y Y 
.sessions[0].message.
exception.url
 Y       
.sessions[0].message.
focusInOffset
 Y   Y Y 
.sessions[0].message.
fromWeb
 Y   Y Y 
.sessions[0].message.
mobileState.orientation
     Y Y 
.sessions[0].message.
mobileState.freeStorage
     Y Y 
.sessions[0].message.
mobileState.battery
     Y Y 
.sessions[0].message.
mobileState.freeMemory
     Y Y 
.sessions[0].message.
mobileState.connectionType
     Y Y 
.sessions[0].message.
mobileState.carrier
     Y Y 
.sessions[0].message.
mobileState.
networkReachability
     Y Y 
.sessions[0].message.
mobileState.ip
     Y Y 
.sessions[0].message.
mobileState.
androidState.keyboardState
       Y 
.sessions[0].message.
offset
 Y   Y Y 
.sessions[0].message.
performance.
navigation.redirectCount
 Y       
.sessions[0].message.
performance.navigation.type
 Y       
.sessions[0].message.
performance.timing.
connectEnd
 Y       
.sessions[0].message.
performance.timing.
connectStart
 Y       
.sessions[0].message.
performance.timing.
domainLookupEnd
 Y       
.sessions[0].message.
performance.
timing.domainLookupStart
 Y       
.sessions[0].message.
performance.timing.
domComplete
 Y       
.sessions[0].message.
performance.timing.
domContentLoadedEventEnd
 Y       
.sessions[0].message.
performance.timing.
domContentLoadedEventStart
 Y       
.sessions[0].message.
performance.timing.
domInteractive
 Y       
.sessions[0].message.
performance.timing.
domLoading
 Y       
.sessions[0].message.
performance.timing.
fetchStart
 Y       
.sessions[0].message.
performance.timing.
loadEventEnd
 Y       
.sessions[0].message.
performance.timing.
loadEventStart
 Y       
.sessions[0].message.
performance.timing.
navigationStart
 Y       
.sessions[0].message.
performance.timing.
redirectEnd
 Y       
.sessions[0].message.
performance.timing.
redirectStart
 Y       
.sessions[0].message.
performance.timing.
responseEnd
 Y       
.sessions[0].message.
performance.timing.
responseStart
 Y       
.sessions[0].message.
performance.timing.
secureConnectionStart
 Y       
.sessions[0].message.
performance.timing.
unloadEventEnd
 Y       
.sessions[0].message.
performance.timing.
unloadEventStart
 Y       
.sessions[0].message.
screenview.name
 Y Y Y Y 
.sessions[0].message.
screenview.referrer
 Y Y Y Y 
.sessions[0].message.
screenview.renderTime
   Y     
.sessions[0].message.
screenview.type
 Y Y Y Y 
.sessions[0].message.
screenview.url
 Y Y     
.sessions[0].message.
screenviewOffset
 Y Y Y Y 
.sessions[0].message.target.
currState.[property based
on control]
 Y   Y Y 
.sessions[0].message.
target.dwell
 Y   Y Y 
.sessions[0].message.
target.id
 Y Y Y Y 
.sessions[0].message.
target.idType
 Y Y     
.sessions[0].message.
target.isParentLink
 Y Y     
.sessions[0].message.
target.name
 Y       
.sessions[0].message.
target.position.height
 Y   Y Y 
.sessions[0].message.
target.position.relXY
 Y Y     
.sessions[0].message.
target.position.width
 Y   Y Y 
.sessions[0].message.
target.position.x
     Y Y 
.sessions[0].message.
target.position.y
     Y Y 
.sessions[0].message.
target.prevState.[property 
based on control]
 Y   Y Y 
.sessions[0].message.
target.subType
 Y   Y Y 
.sessions[0].message.
target.tlType
 Y   Y Y 
.sessions[0].message.
target.type
 Y   Y Y 
.sessions[0].message.
target.visitedCount
 Y   Y Y 
.sessions[0].message.type
 Y   Y Y 
.sessions[0].startTime
 Y   Y Y 
.sessions[0].timezoneOffset
 Y      

Mappings between JSON properties to Tealeaf System Objects

In the table below, you can review how the JSON properties are mapped to hit attributes, events, and dimensions that are provided by Tealeaf.

Table 2. Default Client Framework Objects
Step Attribute Path System Step Attribute As condition for Event feeds Dimension(s) 
.messageVersion
 Step - SDK Version     
.serialNumber
 Step - Serial Number     
.sessions[0].
clientEnvironment.
webEnvironment.
libVersion
 Step - Client Environment Library Version     
.sessions[0].
clientEnvironment.
webEnvironment.page
 Step - Client Environment Page     
.sessions[0].
clientEnvironment.
webEnvironment.screen.
orientation
 Step - Client Environment Screen Orientation     
.sessions[0].
clientEnvironment.
webEnvironment.screen.
orientationMode
 Step - Client Environment Screen Orientation Mode     
.sessions[0].
message.clientState.
event
 Step - ClientState Event Step - Usability Attention Map Viewport Height; Step - Usability Attention Map Y View Time; Step - Usability Focal Slice Y (BB) Step - Usability Focal Slice Y 
.sessions[0].message.
clientState.pageHeight
 Step - ClientState Page Height Step - Usability Attention Map Viewport Height; Step - Usability Focal Slice Y (BB) Step - Usability Focal Slice Y 
.sessions[0].message.
clientState.pageWidth
 Step - ClientState Page Width     
.sessions[0].message.
clientState.
viewPortHeight
 Step - ClientState Viewport Height Step - Usability Attention Map Viewport Height (BB); Step - Usability Attention Map Y View Time; Step - Usability Focal Slice Y (BB) Step - Usability Focal Slice Y; Step - Usability View Port Height 
.sessions[0].message.
clientState.
viewPortWidth
 Step - ClientState Viewport Width     
.sessions[0].message.
clientState.viewPortX
 Step - ClientState Viewport X     
.sessions[0].message.
clientState.viewPortY
 Step - ClientState Viewport Y     
.sessions[0].message.
clientState.viewTime
 Step - ClientState View Time     
.sessions[0].message.
connection.description
 Step - Connection Description     
.sessions[0].message.
connection.initTime
 Step - Connection Init Time     
.sessions[0].message.
connection.loadTime
 Step - Connection Load Time     
.sessions[0].message.
connection.
responseDataSize
 Step - Connection Response Data Size     
.sessions[0].message.
connection.responseTime
 Step - Connection Response Time     
.sessions[0].message.
connection.statusCode
 Step - Connection Status Code     
.sessions[0].message.
connection.url
 Step - Connection URL     
.sessions[0].message.
screenViewOffset
       
.sessions[0].
message.count
 Step - Message Count     
.sessions[0].message.
event.tlEvent
       
.sessions[0].message.
event.type
 Step - TL Event Type     
.sessions[0].message.
event.subType
 Step - Event Type Step - Usability Form Field Visit   
.sessions[0].message.
focusInOffset
 Step - Focus Offset     
.sessions[0].message.
fromWeb
 Step - Message From Web     
.sessions[0].message.
objects.performance.
loadEventStart
 Step - Performance URL Render Time     
.sessions[0].message.
objects.performance.
redirectCount
 Step - Objects Performance Redirect Count     
.sessions[0].message.
objects.performance.
referrer
 Step - Objects Performance Referrer     
.sessions[0].message.
offset
 Step - Offset     
.sessions[0].message.
performance.
navigation.type
 Step - Performance Navigation Type     
.sessions[0].message.
performance.timing.
connectEnd
 Step - Performance Connect End     
.sessions[0].message.
performance.timing.
connectStart
 Step - Performance Connect Start     
.sessions[0].message.
performance.timing.
domainLookupEnd
 Step - Performance Dom Lookup End     
.sessions[0].message.
performance.timing.
domainLookupStart
 Step - Performance Dom Lookup Start     
.sessions[0].message.
performance.timing.
domComplete
 Step - Performance Dom Complete     
.sessions[0].message.
performance.timing.
domContentLoadedEventEnd
 Step - Performance Dom Content Loaded Event End     
.sessions[0].message.
performance.timing.
domContent
LoadedEventStart
 Step - Performance Dom Loaded Event Start     
.sessions[0].message.
performance.timing.
domInteractive
 Step - Performance Dom Interactive     
.sessions[0].message.
performance.timing.
domLoading
 Step - Performance DOM Loading     
.sessions[0].message.
performance.timing.
fetchStart
 Step - Performance Fetch Start     
.sessions[0].message.
performance.timing.
loadEventEnd
 Step - Performance Load Event End     
.sessions[0].message.
performance.timing.
navigationStart
 Step - Performance Navigation Start     
.sessions[0].message.
performance.timing.
redirectEnd
 Step - Performance Redirect End     
.sessions[0].message.
performance.timing.
redirectStart
 Step - Performance Redirect Start     
.sessions[0].message.
performance.timing.
responseEnd
 Step - Performance Response End     
.sessions[0].message.
performance.timing.
responseStart
 Step - Performance Response Start     
.sessions[0].message.
performance.timing.
secureConnectionStart
 Step - Performance Secure Connection Start     
.sessions[0].message.
performance.timing.
unloadEventEnd
 Step - Performance Unload Event End     
.sessions[0].message.
performance.timing.
unloadEventStart
 Step - Performance Unload Event Start     
.sessions[0].message.
screenview.name
 Step - ScreenView Name Step - ScreenView (BB); Step - ScreenView URL (BB) Step - ScreenView; Step - ScreenView URL 
.sessions[0].message.
screenview.renderTime
 Step - ScreenView Render Time     
.sessions[0].message.
screenview.type
 Step - ScreenView Type Step - ScreenView (BB); Step - ScreenView URL (BB) Step - ScreenView; Step - ScreenView URL 
.sessions[0].message.
screenview.url
 Step - ScreenView URL     
.sessions[0].message.
screenviewOffset
 Step - ScreenView Offset     
.sessions[0].message.
target.currState.label
 Step - Target Current Label     
.sessions[0].message.
target.currState.text
 Step - Target Current Text     
.sessions[0].message.
target.currState.value
 Step - Target Current Value     
.sessions[0].message.
target.dwell
 Step - Target Dwell Time     
.sessions[0].message.
target.id
 Step - Target ID Step - Usability Target ID + Type (BB) Step - Target ID 
.sessions[0].message.
target.idType
 Step - Target ID Type Step - Usability Target ID + Type (BB) Step - Target ID 
.sessions[0].message.
target.name
 Step - Target Name     
.sessions[0].message.
target.position.height
 Step - Target Height     
.sessions[0].message.
target.position.relXY
 Step - Target Relative XY Step - Usability Click Step - Target Relative XY 
.sessions[0].message.
target.position.width
 Step - Target Width     
.sessions[0].message.
target.prevState.label
 Step - Target Prev Label     
.sessions[0].message.
target.prevState.text
 Step - Target Prev Text     
.sessions[0].message.
target.prevState.value
 Step - Target Previous Value     
.sessions[0].message.
target.subType
 Step - Target Subtype     
.sessions[0].message.
target.tlType
 Step - Target TL Type     
.sessions[0].message.
target.type
 Step - Target Type     
.sessions[0].message.
target.visitedCount
 Step - Target Visit Count     
.sessions[0].message.
target.xPath
       
.sessions[0].message.
type
 Step - Message Type     
.sessions[0].startTime
 Step - Session Start Time     
.sessions[0].
timezoneOffset
 Step - Timezone Offset    

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