Skip to main content

Advanced mode for events

Advanced mode for events

EES reference - attribute reference

As sessions are captured and evaluated in the Short Term Canister, Tealeaf maintains a series of attributes for individual hits in the session and the overall session.

  • A hit attribute is a numerical or text value pertaining to an individual hit. A hit attribute value can be extracted from the request or response or calculated based on a defined pattern.
  • A step attribute is a hit attribute that is applied to step-based data. It can be referenced and behaves exactly like a hit attribute.
  • A session attribute is an attribute that applies to the entire session. In the Short Term Canister, session attributes are initialized when the first hit of a new session enters the STC and can be updated during the session. These values can be extracted from session data or calculated.

    Note: Write access to user-defined session attributes is permitted only through the defined action of an event.

The following references are available for use in the Event Manager. In particular, you can use them as conditions in event definitions.

Note: Attribute reference information includes the JavaScript™ for each attribute to reference in Advanced Mode.

Session attribute reference

Session attributes are available at any time during the session. These values are running totals.

For example, if the session is 20 hits, the value of Length of session in time on hit #10 is the length of session for hits 1-10.

  • Session attributes can be included in any event trigger. However, they only represent the final statistics for the session when they are evaluated in the End of Session trigger.
  • In EventEngineScripting, references to session attributes begin with $S.*.
Table 1. Session Attribute Reference - Name space = TL
Internal name JavaScript variable Type Display name Source type Name of source Description
S_BROWSER_OS BrowserOS string Browser OS PATTERN TL.TLT_BROWSER_PLATFORM Visitor operating system
S_BROWSER_TYPE Browser Type string Browser Type PATTERN TL.TLT_BROWSER Visitor browser type
S_BROWSER_VERSION Browser Version string Browser Version PATTERN TL.TLT_BROWSER_VERSION Visitor browser type and version
S_CUI_COUNT CUICount int CUI Hit Count Running Total CALCULATED _SOURCE   Running count of CUI hits
S_DISCARD_SESSION Discard Session boolean Discard Session Flag CALCULATED _SOURCE   Discard session event triggered? (T/F)
S_DOMAIN_NAME Domain Name string Domain Name of Server PATTERN TL.HTTP_HOST Domain name of server
S_EXPIRATION_TIME Expiration Time int Expiration Time Epoch for Session (sec) CALCULATED _SOURCE   Time in seconds between the last hit of session and session timeout value
S_FIRST_PAGE_URL FirstPage URL string First Page of Session URL PATTERN TL.TLT_URL  
S_HIT_COUNT Number Of ,Hits int Hit Count Running Total CALCULATED _SOURCE   Running count of hits
S_ID ID int64 Session ID in Canister CALCULATED _SOURCE   ID of session in canister where it is stored
S_IMG_COUNT ImgCount int Image Count Running Total CALCULATED _SOURCE    
S_INTERESTING Interesting boolean Intere- sting Flag CALCULATED _SOURCE   Is interesting session? (Always true)
S_IP IP ansistring Client IP address PATTERN TL.REMOTE_ADDR Visitor IP address
S_IS_BOT IsBot boolean Bot (T/F) CALCULATED _SOURCE   Is bot? (T/F)
S_LAST_HIT_TIME_EPOCH LastHit Epoch int Last Hit Req Time Epoch (?sec) PATTERN TL.RESPONSE_ TIME_EX  
S_LAST_PAGE_URL LastPage URL string Last Page of Session URL PATTERN TL.TLT_URL  
S_LICENSED_PAGE_COUNT Licensed PageCount int Licensed Page Count Running Total CALCULATED _SOURCE   Running count of licensed pages
S_OTHER_COUNT Other Count int Other Hit Type Running Total CALCULATED _SOURCE    
S_PAGE_COUNT PageCount int Page Count Running Total CALCULATED _SOURCE   Running count of pages
S_REFERRER Referrer string Referrer for Session PATTERN TL.HTTP_REFERRER  
S_REFERRER_DOMAIN Referrer Domain string Referrer Domain for Session PATTERN TL.REFERRER_DOMAIN Domain of session referrer
S_REQ_CANCELLED_ HIT_COUNT Req Cancelled HitCount int Request Canceled Running Total CALCULATED _SOURCE   Running count of request canceled hits
S_START_TIME_EPOCH StartTime Epoch int First Hit Req Time Epoch (?sec) PATTERN TL.REQUEST_ TIME_EX Time epoch in microseconds when server receives the first request in session
S_TIME_OUT Session TimeOut int Session Timeout Value (sec) CALCULATED _SOURCE   Session timeout value in seconds
S_TLTSID TLTSID string Session GUID PATTERN TL.TLTSID  
S_TLTUID TLTUID string User GUID PATTERN TL.TLTUID  
S_TLTVID TLTVID string Visitor GUID PATTERN TL.TLTVID  
S_TOTAL_REQ_BYTES TotalREQ Bytes int Req Size Running Total (bytes) CALCULATED _SOURCE   Running total of Req sizes
S_TOTAL_RSP_BYTES TotalRSP Bytes int Rsp Size Running Total (bytes) CALCULATED _SOURCE   Running total of Rsp sizes
S_TOTAL_TIME TotalTime int64 Session Length Running Time (sec) CALCULATED _SOURCE    
S_TRAFFIC_TYPE TrafficType string Browser Traffic Type PATTERN TL.TLT_TRAFFIC_TYPE User agent traffic type. Examples: browser, mobile, bot
S_USER_AGENT UserAgent string User Agent of Client PATTERN TL.USERAGENT  

Hit attribute reference

This topic describes the hit attributes provided by Tealeaf. Hit attributes only pertain to the current hit.

  • Hit attributes are only available in the following triggers: First Hit, Last Hit, Every Hit.
  • To retain specific hit attribute values across multiple hits and event triggers, you must store the hit attribute value in a session attribute, which is available through the session object and is stored with the session data.
  • In EventEngineScripting, references to hit attributes begin with $H.*.

    Regarding creating event objects in Advanced mode, pattern objects differ from hit attributes.

  • Hit attributes gather data from other data sources within the Canister for the current hit.
  • Like user-defined hit attributes, pattern objects use start and end tags to identify data in the request or response.
  • In Basic Mode in the Event Manager, these object types are indistinguishable when listed in the Hit Attributes tab.
Table 2. Hit Attribute Reference - Name space = TL
Internal name JavaScript variable Type Display name Source type Name of source Description
H_CONN_SPEED Conn Speed int Connection Speed PATTERN TL.CONN_SPEED Connection speed in bytes/second
H_CONN_TYPE ConnType ansistring Connection Type PATTERN TL.CONN_TYPE Connection speed category. Example: T1
H_CONTENT_ENCODING Content Encoding string Content Encoding PATTERN TL.RESPONSE_TYPE Content encoding format of response. Example: text/html; charset =ISO-8859-1
H_GEN_TIME GenTime int Hit Generation Time (sec) PATTERN TL.WS_GENERATION Time in microseconds between server receiving request and starting to send response. Formula: (Rsp Start Time Epoch - Req Time Epoch)
H_IS_CUI IsCUI boolean Client UI Hit (T/F) CALCULATED_SOURCE   Client user-interface hit (T/F). Requires Tealeaf UI Capture.
H_NETWORK_TRIP Network Trip int Network Time (sec) PATTERN TL.NT_TOTAL Time in microseconds between server starting to send response and client acknowledges response. Formula: (Rsp ACK Time Epoch - Rsp Start Time Epoch)
H_NUMBER Hit Number int Hit Number in Session CALCULATED_SOURCE   Hit number in session
H_PERFORMANCE_ RENDER_TIME Performance Render Time int64 Perfor- mance Render Time (ms) CALCULATED_SOURCE   Time in milliseconds it took the page to complete rendering. This does not include the page load time. Requires Tealeaf UI Capture.
H_QUERY_STRING Query String string Query String for Request PATTERN TL.QUERY_STRING  
H_REFERRER Referrer string Hit Referrer PATTERN TL.HTTP_REFERRER Referrer value for hit
H_REQ_CANCELLED Req Cancelled bool Req Cancelled PATTERN TL.REQ_CANCELLED  
H_REQ_DISCARDED Req Discarded bool Req Discarded PATTERN TL.REQ_DISCARDED  
H_REQ_SIZE ReqSize int Req Size (bytes) PATTERN TL.REQUEST_SIZE Size in bytes of request data + request header
H_REQ_TIME_EX Request TimeEx int Req Time Epoch (?sec) PATTERN TL.REQUEST_TIME_EX Time epoch in microseconds when server receives request
H_ROUND_TRIP RoundTrip int Round Trip Time (?sec) PATTERN TL.RT_TOTAL Time in micro- seconds between server receiving request and client acknowledging response. Formula: (Rsp ACK Time Epoch - Req Time Epoch)
H_RSP_ACK_TIME_EX Response AckTime Ex int Rsp Ack Time Epoch (?sec) PATTERN TL.RESPONSE_ACK_ TIME_EX Time epoch in microseconds when client acknowledges response
H_RSP_SIZE RspSize int Rsp Size (bytes) PATTERN TL.RESPONSE_SIZE Size in bytes of response data + response header
H_RSP_START_ TIME_EX Response StartTime Ex int Rsp Start Time Epoch (?sec) PATTERN TL.RESPONSE_START_TIME_EX Time epoch in microseconds when server starts sending response
H_RSP_TIME_EX Response TimeEx int Rsp End or Hit Time Epoch (?sec) PATTERN TL.RESPONSE_TIME _EX Time epoch in microseconds when server ends sending response
H_STATUS_CODE StatusCode int Status Code PATTERN TL.STATUS_CODE Status code of response. Example: 200
H_TLAPI_ARRIVAL_TIME_EX TLapi Arrival TimeEx int64 TL API Arrival Time Epoch (?sec) PATTERN TL.TLAPI_ARRIVAL_TIME_EX Time epoch in micro- seconds of hit arrival, as reported by the Tealeaf API
H_TLTHID TLTHID ansistring Hit GUID PATTERN TL.TLTHID  
H_TYPE HitType int Hit Type PATTERN TL.CAPTURE_TYPE Hit and Capture Type
H_URL URL string URL PATTERN TL.URL URL of hit, without normalization, as reported in the browser

Pattern objects reference

Pattern objects are pre-defined objects that are provided by Tealeaf and that can be used to detect patterns in the request and response data. These objects are available for use in the Hit Attributes tab.

  • When you create event objects in Advanced mode, pattern objects differ from hit attributes.
    • Hit attributes gather data from other data sources within the Canister for the current hit.
    • Like user-defined hit attributes, pattern objects use start and end tags to identify data in the request or response.
    • In Basic Mode in the Event Manager, these object types are indistinguishable when listed in the Hit Attributes tab.
  • To retain specific pattern object values across multiple hits and event triggers, you must store the data in a session attribute, which is available through the session object and is stored with the session data.
  • In EventEngineScripting, references to hit attributes begin with $H.*.
Table 3. Pattern Objects Reference - Name space = CUST
Internal name Identifier HTTP type Case sensitive? Match all? Encoding Datatype Start tag End tag Description
LOGIN_ID_ TEMPLATE_ PATTERN 0 Request True False UTF8 Text \r\n loginid= \r\n Login ID.
Table 4. Pattern Objects Reference - Name space = Tl Name of Screenview
Internal name Identifier HTTP type Case sensitive? Match all? Encoding Data type Start tag End tag Description
STEP_TARGET _CURRENT_ LABEL   Request True True UTF8  
  • .sessions [0]
  • .message
  • .target
  • .currState
  • .label
   Step, target current label
Table 5. Pattern Objects Reference - Name Space = TL
Internal name Identifier HTTP type Case sensitive? Match all? Encoding Data type Start tag End tag Description
CAPTURE_ SOURCE 0 Request True False UTF8 Text \r\nCapture Source= \r\n Capture source. Host name of PCA
CAPTURE_ VERSION 0 Request True False UTF8 Text \r\nCapture Version= \r\n Version of UI Capture.
HTTP_ ACCEPT _ LANGUAGE 0 Request True False UTF8 Text \r\nHTTP_ ACCEPT_ LANGUAGE= \r\n Accept language. Visitor language preference. Example: en-us
HTTP_ CONNECTION 0 Request True False UTF8 Text \r\nHTTP_ CONNECTION= \r\n HTTP connection. Example: keep-alive
HTTP_HOST 0 Request True False UTF8 Text \r\nHTTP_ HOST= \r\n Host name.
HTTP_X _TEALEAF 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF= \r\n CUI hit type as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ ALERT_ COUNT 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ ALERT_ COUNT= \r\n CUI alert count of client user interface alerts. Requires UI Capture.
HTTP_X _TEAL EAF_B ROWSE R_RES 0 Request True False UTF8 Text \r\n HTTP_X_ TEALEAF _BROWSER_RES= \r\n CUI browser resolution as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ DEVICE 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ DEVICE=   Mobile hit. Requires Mobile Capture SDK.
HTTP_X_ TEALEAF_ PAGE_CUI_ BYTES 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_CUI_ BYTES= \r\n CUI event message size in characters of client user interface events, as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ PAGE_CUI _EVENTS 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_CUI _EVENTS= \r\n CUI event count of client user interface events, as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ PAGE_DWELL 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_DWELL= \r\n CUI hit dwell time in milli- seconds, as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ PAGE_IMG_ FAIL 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_IMG _FAIL= \r\n CUI hit mage failure count of broken images on hit, as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ PAGE_ RENDER 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_ RENDER= \r\n CUI hit render time in milliseconds, as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAF_ PAGE_URL 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF_ PAGE_URL= \r\n CUI hit URL as reported from client user interface. Requires UI Capture.
HTTP_X_ TEALEAFTYPE 0 Request True False UTF8 Text \r\nHTTP_X_ TEALEAF TYPE= \r\n CUI hit type as reported from client user interface. Requires UI Capture.
HTTPS 0 Request True False UTF8 Text \r\nHTTPS= \r\n SSL used. SSL in use? (On or Off)
LOCAL_ADDR 0 Request True False UTF8 Text \r\n LOCAL_ADDR= \r\n Server IP address (LOCAL_ ADDR)
LOGIN_ID_ TEMPLATE_ PATTERN 0 Request True False UTF8 Text \r\n loginid= \r\n Login ID.
REFERRER_ DOMAIN 0 Request True False UTF8 Text \r\n REFERRER _DOMAIN= \r\n Referrer domain for hit.
REMOTE_ ADDR 0 Request True False UTF8 Text \r\nREMOTE _ADDR= \r\n Client IP address. Visitor IP address (REMOTE_ ADDR).
REQ_BUFFER _ENCODING 0 Request True False UTF8 Text \r\n REQ_ BUFFER_ ENCODING= \r\n Req buffer encoding
REQ_ BUFFER_ ORIG_ ENCODING 0 Request True False UTF8 Text \r\n REQ_ BUFFER_ ORIG_ ENCODING= \r\n Req buffer encoding (original). Encoding of original request before any transformation. Example: UTF-8
REQ_ CANCELLED 0 Request True False UTF8 Text \r\nReq Cancelled= \r\n Request canceled type. Request canceled? (False/Client/Server)
REQ_DATA_ SIZE 0 Request True False UTF8 Num eric \r\nRequest DataSize= \r\n Request data size (bytes).
REQ_ HEADER_ SIZE 0 Request True False UTF8 Num eric \r\nRequest HeaderSize= \r\n Request header size (bytes).
REQUEST _METHOD 0 Request True False UTF8 Text \r\nREQUEST _METHOD= \r\n Request method. Example: POST
REQUEST _TIME_EX 0 Request True False UTF8 Text \r\n Request TimeEx= \r\n Request timestamp. Time when server receives request
RESPONSE_ ACK_TIME_ EX 0 Request True False UTF8 Text \r\n Response AckTimeEx= \r\n Response acknowledge timestamp. Time when client acknowledges response.
RESPONSE_ START_ TIME_EX 0 Request True False UTF8 Text \r\n Response Start TimeEx= \r\n Response start timestamp. Time when server starts sending response.
RESPONSE_ TIME_EX 0 Request True False UTF8 Text \r\n Response TimeEx= \r\n Response end timestamp. Time when server ends sending response.
RSP_BODY_ ENCODING 0 Request True False UTF8 Text \r\nRESP _BODY_ ENCODING= \r\n Response body encoding. Example: iso-8859-1.
RSP_DATA _SIZE 0 Request True False UTF8 Num eric \r\nResponse DataSize= \r\n Response data size in bytes.
RSP_HEADER _SIZE 0 Request True False UTF8 Num eric \r\nResponse HeaderSize= \r\n Response header size in bytes.
SERVER _PROTOCOL 0 Request True False UTF8 Text \r\nSERVER _PROTOCOL= \r\n Server protocol that is used by Tealeaf server. Example: HTTP/1.1.
STEP_ CLIENT_ ENV_LIB_ VERSION   Request True True UTF8   .sessions [0].client Environment .web Environment .libVersion   Step, client environment library version
STEP_ CLIENT_ ENV_OS_ VERSION   Request True True UTF8   .client Environment .os Version   Step, client environment OS version
STEP_ CLIENT_ ENV_PAGE   Request True True UTF8   .sessions [0].client Environment .web Environment. page   Step, client environment page
STEP_ CLIENT_ ENV_SCREEN_ ORIENTATION   Request True True UTF8   .sessions [0].client Environment .web Environment. screen. orientation   Step, client environment screen orientation
STEP_ CLIENT_ENV_ SCREEN_ ORIENTATION _MODE   Request True True UTF8   .sessions [0]. client Environment. web Environment. screen. orientation Mode   Step, client environment screen orientation mode in degrees
STEP_ CLIENT_ STATE_ EVENT   Request True True UTF8   .sessions [0]. message .client State.event   Step, ClientState event
STEP_ CLIENT STATE_ PAGE_HEIGHT   Request True True UTF8   .sessions [0]. message. client State. pageHeight   Step, ClientState page height
STEP_ CLIENT STATE_ PAGE _ WIDTH   Request True True UTF8   .sessions [0]. message .client State. pageWidth   Step, ClientState page width
STEP_ CLIENT STATE_ VIEW _ TIME   Request True True UTF8   .sessions [0]. message .client State. viewTime   Step, ClientState view time in milliseconds
STEP_ CLIENT STATE_ VIEW PORT_ HEIGHT   Request True True UTF8   .sessions [0]. message .client State. viewPort Height   Step, ClientState viewport height
STEP_ CLIENT STATE_ VIEW PORT_ WIDTH   Request True True UTF8   .sessions [0]. message. client State .viewPort Width   Step, ClientState viewport width
STEP_ CLIENT STATE_ VIEW PORT_X   Request True True UTF8   .sessions [0]. message. client State. viewPortX   Step, ClientState viewport X with (0,0) being the upper left corner
STEP_ CLIENT STATE_ VIEWPORT_Y   Request True True UTF8   .sessions [0]. message .client State. viewPortY   Step, ClientState viewport Y with (0,0) being the upper left corner
STEP_CONN _DESC   Request True True UTF8   .sessions [0]. message .connection. description   Step, connection description
STEP_CONN _INIT_TIME   Request True True UTF8   .sessions [0].message. connection. initTime   Step, connection init time in millisecond
STEP_CONN _LOAD_TIME   Request True True UTF8   .sessions [0].message. connection. loadTime   Step, connection load time in milliseconds
STEP_CONN _RSP_DATA _SIZE   Request True True UTF8   .sessions [0].message. connection. response DataSize   Step, connection response data size
STEP_CONN _RSP_SIZE   Request True True UTF8   .sessions [0].message. connection. responseTime   Step, connection response time
STEP_CONN _STATUS_ CODE   Request True True UTF8   .sessions [0].message. connection. statusCode   Step, connection status code
STEP_CONN _URL   Request True True UTF8   .sessions [0].message. connection .url   Step, connection URL
STEP_EVENT _TYPE   Request True True UTF8   .sessions [0].message. event.type   Step, event type
STEP_FOCUS _OFFSET   Request True True UTF8   .sessions [0].message .focus InOffset   Step, focus offset. Time in milliseconds that object got focus from start of session
STEP _MESSAGE _COUNT   Request True True UTF8   .sessions [0].message .count   Step, message count. Running count of step messages per session. For UISDK, a session can be from page load, not the start of the user session.
STEP_ MESSAGE _FROM_WEB   Request True True UTF8   .sessions [0].message. fromWeb   Step, message from web. Returns true or false
STEP _MESSAGE _TYPE   Request True True UTF8   .sessions [0].message .type   Step, message type. Internal categorization of message type.
STEP_OFFSET   Request True True UTF8   .sessions [0].message .offset   Step, offset. Time in ms from the start of the session. For UISDK, a session can be from page load, not the start of the user session.
STEP_PERF _CONNECT _END   Request True True UTF8   .sessions [0].message .performance .timing connectEnd   Step - Performance Connect End. Time immediately after the user agent finishes establishing the connection to the server to retrieve the current document
STEP_PERF _CONNECT _START   Request True True UTF8   .sessions [0].message .performance .timing .connect Start   Step, performance connect start time immediately before the user agent sets the current document readiness to "complete"
STEP_PERF _DOM_ COMPLETE   Request True True UTF8   .sessions [0].message .performance .timing .domComplete   Step, performance DOM complete
STEP_PERF _DOM _CONTENT _LOADED _EVENT_END   Request True True UTF8   .sessions [0]. message .performance .timing. domContent Loaded EventEnd   Step, performance DOM content loaded event end. Time immediately before the user agent sets the current document readiness to "complete".
STEP_PERF _DOM_FETCH _START   Request True True UTF8   .sessions [0].message .performance .timing .fetchStart   Step, performance fetch start. Time immediately before the user agent starts checking any relevant application caches.
STEP_PERF _DOM_ INTERACTIVE   Request True True UTF8   .sessions [0].message .perform ance .timing. dom Interactive   Step, performance DOM interactive. Time immediately before the user agent sets the current document readiness to "interactive".
STEP_PERF_ DOM_LOAD_ EVENT_END   Request True True UTF8   .sessions [0].message .performance .timing. loadEventEnd   Step, performance load Event end. Time when the load event of the current document is completed.
STEP_PERF_ DOM_LOAD_ EVENT_START   Request True True UTF8   .sessions [0].message .performance .timing .loadEvent Start   Step, performance load Event start. Time immediately before the load event of the current document is fired.
STEP_PERF_ DOM_LOADING   Request True True UTF8   .sessions [0].message .performance .timing .domLoading   Step, performance DOM loading. Time immediately before the user agent sets the current document readiness to "loading".
STEP_PERF _DOM_LOADED _EVENT_ START   Request True True UTF8   .sessions [0].message .performance .timing.dom Content Loaded EventStart   Step, performance DOM loaded event start. Time immediately before the user agent fires the DOMContent Loaded event at the Document.
STEP_PERF_ DOM_LOOKUP _END   Request True True UTF8   .sessions [0].message .performance .timing .domain LookupEnd   Step, performance DOM lookup end. Time immediately after the user agent finishes the domain name lookup for the current document
STEP_PERF_ DOM_LOOKUP _START   Request True True UTF8   .sessions [0].message .performance .timing .domain LookupStart   Step, performance DOM lookup start. Number of redirects from initial request to current hitTime immediately before the user agent starts the domain name lookup for the current document.
STEP_PERF_ NAV_ REDIRECT _COUNT   Request True True UTF8   .sessions [0].message .performance .navigation .redirect Count   Step, performance navigation redirect count. Number of redirects from initial request to current hit.
STEP_PERF_ NAV_START   Request True True UTF8   .sessions [0].message .performance .timing .navigation Start   Step, performance navigation start. Time immediately after the user agent finishes prompting to unload the previous document.
STEP_PERF _NAV_TYPE   Request True True UTF8   .sessions [0].message .performance .navigation .type   Step, performance navigation type.
STEP_PERF_ REDIRECT _END   Request True True UTF8   .sessions [0].message .performance .timing. redirectEnd   Step, performance redirect end. Time immediately after receiving the last byte of the response of the last redirect.
STEP_PERF_ REDIRECT_ START   Request True True UTF8   .sessions [0].message .performance .timing .redirect Start   Step, performance redirect start. Starting time of the fetch that initiates the redirect.
STEP_PERF_ RESPONSE_ END   Request True True UTF8   .sessions [0].message .performance .timing .responseEnd   Step, performance response end. Time immediately after the user agent receives the last byte of the current document or immediately before the transport connection is closed, whichever comes first.
STEP_PERF_ RESPONSE_ START   Request True True UTF8   .sessions [0].message .performance .timing .response Start   Step, performance response start. Time immediately after the user agent receives the first byte of the response from the server, or from relevant application caches or from local resources.
STEP_PERF_ SECURE_ CONN_START   Request True True UTF8   .sessions [0].message .performance .timing .secure Connection Start   Step, performance secure connection start. Time immediately before the user agent starts the handshake process to secure the current connection.
STEP_PERF_ UNLOAD_ EVENT _END   Request True True UTF8   .sessions [0].message .performance .timing .unload EventEnd   Step, performance unload event end. Time immediately after the user agent finishes the unload event of the previous document.
STEP_PERF_ UNLOAD_ EVENT_START   Request True True UTF8   .sessions [0].message .performance .timing .unload EventStart   Step, performance unload event start. Time immediately before the user agent starts the unload event of the previous document.
STEP_RENDER TIME   Request True True UTF8   .sessions [0].message .performance .timing .renderTime   Step, render time
STEP_SCREEN VIEW_NAME   Request True True UTF8   .sessions [0].message .screenview .name   Step, screenview name
STEP_SCREEN VIEW_OFFSET   Request True True UTF8   .sessions [0].message .screenview Offset   Step, screenview offset. Time that is offset in ms from the last ScreenView load. If there is no ScreenView load for a page load, ScreenView offset is the epoch in ms.
STEP_SCREEN VIEW_ REFERRING_ SCREENVIEW   Request True True UTF8   .sessions [0].message .screenview .referrer   Step, screenview referring screenview for the current screenview.
STEP_SCREEN VIEW_RENDER _TIME   Request True True UTF8   .sessions [0].message .screenview .renderTime   Step, screenview render time in milliseconds.
STEP_SCREEN VIEW_TYPE   Request True True UTF8   .sessions [0].message .screenview .type   Step, screenview type. Indicates whether a screenview was loaded or unloaded.
STEP_SCREEN VIEW_URL   Request True True UTF8   .sessions [0].message .screenview .url   Step, screenview URL
STEP_SDK_ VERSION   Request True True UTF8   .message Version   Step, SDK version
STEP_SERIAL _NUMBER   Request True True UTF8   .serial Number   Step, serial number. Running count of SDK sessions in the user session. With a UI SDK, a session can equal page load.
STEP_ SESSION _START_TIME   Request True True UTF8   .sessions [0].start Time   Step, session start time. Epoch in ms for start of this 'session'. For UISDK, a session can be from page load, not the start of the user session.
STEP_TARGET _CURRENT_ LABEL   Request True True UTF8   .sessions [0].message .target .currState .label   Step, target current label
STEP_TARGET _CURRENT _TEXT   Request True True UTF8   .sessions [0].message .target .currState .text   Step, target current text
STEP_TARGET _CURRENT_ VALUE   Request True True UTF8   .sessions [0].message .target .currState .value   Step, target current value
STEP_TARGET _DWELL_TIME   Request True True UTF8   .sessions [0].message .target .dwell   Step, target dwell time
STEP_TARGET _HEIGHT   Request True True UTF8   .sessions [0].message .target .position .height   Step, target height
STEP_TARGET _ID   Request True True UTF8   .sessions [0].message .target.id   Step, target ID
STEP_TARGET _ID_TYPE   Request True True UTF8   .sessions [0].message .target .idType   Step, target ID type
STEP_TARGET _NAME   Request True True UTF8   .sessions [0].message .target.name   Step, target name
STEP_TARGET _PREV_LABEL   Request True True UTF8   .sessions [0].message .target .prevState .label   Step, target previous label
STEP_TARGET _PREV_TEXT   Request True True UTF8   .sessions [0].message .target .prevState .text   Step, target previous text
STEP_TARGET _PREV_VALUE   Request True True UTF8   .sessions [0].message .target .prevState .value   Step - Target Previous Value
STEP_TARGET _RELATIVE _XY   Request True True UTF8   .sessions [0].message .target .position .relXY   Step, target relative XY
STEP_TARGET _SUBTYPE   Request True True UTF8   .sessions [0].message .target .subType   Step, target subtype
STEP_TARGET _TL_TYPE   Request True True UTF8   .sessions [0].message .target .tlType   Step, target TL type
STEP_TARGET _TYPE   Request True True UTF8  
  • .sessions [0].message
  • .target
  • .type
   Step, target type
STEP_TARGET _VISIT _COUNT   Request True True UTF8  
  • .sessions [0].message
  • .target
  • .vistedCount
   Step, target visit count
STEP_TARGET _WIDTH   Request True True UTF8  
  • .sessions [0].message
  • .target
  • .position
  • .width
   Step, target width
STEP_TIME ZONE_OFFSET   Request True True UTF8  
  • .sessions [0].time
  • zoneOffset
   Step, timezone offset in minutes from GMT.
STEP_TL _EVENT_TYPE   Request True True UTF8  
  • .sessions [0].message
  • .event
  • .tlEvent
   Step, TL event type
STREAMING _HIT 0 Request True False UTF8 Text \r\n Streaming Hit= \r\n Streaming hit. Hit is a stream hit? (T/F)
STREAMING _HIT_TYPE 0 Request True False UTF8 Text \r\n Streaming HitType= \r\n Streaming hit type. Type of streaming hit
TEALEAF_ MOBILE_ DEVICE_TYPE 0 Request False True     \r\nHTTP_ X_TEALEAF =Device ( ) Mobile device type. Requires Mobile Capture SDK.
TLAPI_ ARRIVAL_ TIME_EX 0 Request True False UTF8 Text \r\nTLapi Arrival TimeEx= \r\n TL API arrival timestamp
TLT_ APPLICATION _NAME 0 Request True False UTF8 Text \r\nTLT_ APPLICAT ION_NAME= \r\n App name (normalized)
TLT_BROWSER 0 Request True False UTF8 Text \r\nTLT _BROWSER= \r\n Browser type. Example: IE.
TLT_BROWSER _PLATFORM 0 Request True False UTF8 Text \r\nTLT _BROWSER _PLATFORM= \r\n Browser OS
TLT_BROWSER _VERSION 0 Request True False UTF8 Text \r\nTLT _BROWSER _VERSION= \r\n Browser type and version
TLT_CUI_ APPLICATION _NAME 0 Request True False UTF8 Text \r\nTLT _CUI_APP LICATION _NAME= \r\n CUI application name
TLT_CUI_URL 0 Request True False UTF8 Text \r\nTLT_ CUI_URL= \r\n CUI URL as reported from client user interface. Requires UI Capture.
TLT_HOST_ NAME 0 Request True False UTF8 Text \r\nTLT _HOST_NAME= \r\n Host name (normalized)
TLT_SERVER 0 Request True False UTF8 Text \r\nTLT _SERVER= \r\n Server (normalized)
TLT_TRAFFIC _TYPE 0 Request True False UTF8 Text \r\nTLT _TRAFFIC _TYPE= \r\n Traffic type. Example: Bot
TLT_URL 0 Request True False UTF8 Text \r\nTLT _URL= \r\n URL (normalized) for hit without arguments.
TLTSID 0 Request True False UTF8 Text \r\n TLTSID= \r\n Session GUID
TLTUID 0 Request True False UTF8 Text \r\n TLTUID= \r\n User GUID
TLTVID 0 Request True False UTF8 Text \r\n TLTVID= \r\n Visitor GUID
TRANSFER _ENCODING 0 Request True False UTF8 Text \r\n TRANSFER_ ENCODING= \r\n Transfer encoding. Example: chunked
USERAGENT 0 Request True False UTF8 Text \r\nHTTP _USER_ AGENT= \r\n User Agent

Dimension reference

This topic describes the dimensions that are provided by Tealeaf. These dimensions are created from building block events or are generated based on extended user agent parsing.

  • Dimensions store data at the time of event execution for events, hit attributes, and session attributes. These dimensions use source data objects that are provided by Tealeaf.

    Note: Some additional configuration may be required.

  • The URL (Normalized), Host, Application, and Server dimensions are contained in the URL/Host/App/Server report group.
  • The other dimensions are not associated with any report group by default.

    Note: To record values, a dimension must be associated with at least one report group.

  • In Basic Mode in the Event Manager, these object types are listed in the Dimensions tab.
Table 6. Dimension Reference
Name space Internal Name Type Display Name Source Type Name of Source Description
TL DIM_CONN _TYPE string Connection Type EVENT (building block) TL.E_REPORT _WS_ CONNECTION _TYPE Type of connection (Dialup, DSL, ISDN, T1)
TL DIM_TLT_ CONTENT _TYPE string Content Type EVENT (building block) TL.E_ REPORT_WS _CONTENT _TYPE Type of content: PAGE or not set
TL DIM_MOBILE _DEVICE string Mobile Device EVENT TL.E_MOBILE _DEVICE _TYPE Identifier of mobile device that is used in session (for example, "ios")
TL DIM_REQ _CANCEL string Request Cancelled EVENT (building block) TL.E_REPORT _WS_PAGE _REQ_ CANCEL Was the request canceled (T/F)?
TL DIM_STEP_ SCREENVIEW string Step - ScreenView EVENT (building block) TL.E_STEP_ SCREENVIEW Records the latest ScreenView for each ScreenView LOAD message
Note: This dimension applies only to cxOverstat.
TL DIM_STEP _ SCREENVIEW _URL string Step - ScreenView URL EVENT (building block) TL.E_ SCREENVIEW _URL Records the latest URL for each ScreenView LOAD message
Note: This dimension applies only to cxOverstat.
TL DIM_STEP _TARGET _ID string Step - Target ID EVENT (building block) TL.E_ USABILITY _TARGET _ID ID of object being acted on

Note: This dimension applies only to cxOverstat.
TL DIM_STEP_ FOCAL_ SLICE_Y string Step - Usability Focal Slice Y EVENT (building block) TL.E_STEP _USABILITY _FOCAL_ SLICE_Y Records the Y focal slice

Note: This dimension applies only to cxOverstat.
TL DIM_STEP_ VIEW_PORT _HEIGHT string Step - Usability View Port Height EVENT (building block) TL.E_ USABILITY _ATTENTION _VIEWPORT _HEIGHT Records the View Port Height of the browser

Note: This dimension applies only to cxOverstat.
TL DIM_TLT_APP string Application PATTERN TL.TLT_ APPLICATION _NAME Application name (for example, "store")
TL DIM_TLT _HOST string Host name PATTERN TL.TLT _HOST_NAME Host name (for example, "www.myco. com")
TL DIM_TLT _SERVER string Server PATTERN TL.TLT _SERVER Server IP address (for example, "255.255. 255.255")
TL DIM_STEP_ TARGET_ RELATIVE _XY string Step - Target Relative XY PATTERN TL.STEP_ TARGET_ RELATIVE_ XY Records the relative position of action that is based on object being acted on

Note: This dimension applies only to cxOverstat.
TL DIM_TLT_ TRAFFIC_ TYPE string Traffic Type PATTERN TL.TLT_ TRAFFIC _TYPE Type of traffic (for example, "MOBILE")
TL DIM_TLT_URL string URL (Norma- lized) PATTERN TL.TLT_URL URL normalized by extended user agent parsing (for example, "/default page.asp")

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