UI Telemetry Navigation Timing events capture network performance metrics related to page navigation. The event extends from the UI Telemetry Resource Timing Event and includes requests initiated with either the Fetch API or the XMLHttpRequest API. This object is available in API version 61.0 and later.
For information about navigation timing attributes, including a diagram of the order that attributes follow, see section 4.1 of the W3 Standards on Navigation Timing Level 2.
Fields
APP_NAME
Type: String
Description: The name of the application that the user accessed.
BROWSER_NAME
Type: String
Description: The name of the browser that the user accessed.
Examples: Chrome, Safari
BROWSER_VERSION
Type: String
Description: The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version.
CLIENT_GEO
Type: String
Description: The geolocation of the client in the form of <Country>/<State|Province>.
Example: United States/California
CLIENT_ID
Type: String
Description: The API client ID.
CLIENT_IP
Type: String
Description: The IP address of the client that’s using Salesforce services. A Salesforce internal IP, such as a login from AppExchange, is shown as Salesforce.com IP.
Example: 96.43.144.26
CONNECT_END
Type: Number
Description: The time in milliseconds when the browser establishes a connection to a server so that it can retrieve a resource.
To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT_START time from the CONNECT_END time.
CONNECT_START
Type: Number
Description: The time in milliseconds after the browser completes the Domain Name System (DNS) lookup and begins connecting to a server so that it can retrieve a resource.
To calculate the Transport Control Protocol (TCP) handshake time, subtract the CONNECT_START time from the CONNECT_END time.
CONNECTION_TYPE
Type: String
Description: The type of connection.
Possible values:
CDMA1x
CDMA
EDGE
EVDO0
EVDOA
EVDOB
GPRS
HRPD
HSDPA
HSUPA
LTE
WIFI
DECODED_BODY_SIZE
Type: Number
Description: The size in octets of the HTTP message body after the removal of any applied content encoding.
DEVICE_MODEL
Type: String
Description: The name of the device model.
Examples: iPad, iPhone
DEVICE_PLATFORM
Type: String
Description: The type of application experience in name:experience:form format.
Possible values:
name - APP_BUILDER, CUSTOM, S1, SFX
experience - BROWSER, HYBRID
form - DESKTOP, PHONE, TABLET
DEVICE_SESSION_ID
Type: String
Description: The unique identifier of the user’s session based on page load time. When the user reloads a page, a new session is started.
Example: 321a1ddfaf924803a075f1e69fc87bc06f53ccd0
DOM_COMPLETE
Type: Number
Description: The time in milliseconds when the page’s readyState property is set to complete. Indicates that the page and its subresources have finished loading.
DOM_CONTENT_LOADED_EVENT_END
Type: Number
Description: The time in milliseconds when the page’s DOMContentLoaded event handler completes.
To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM_CONTENT_LOADED_EVENT_START time from the DOM_CONTENT_LOADED_EVENT_END time.
DOM_CONTENT_LOADED_EVENT_START
Type: Number
Description: The time in milliseconds when the page’s DOMContentLoaded event handler starts.
To calculate the processing time for the DOMContentLoaded event handler, subtract the DOM_CONTENT_LOADED_EVENT_START time from the DOM_CONTENT_LOADED_EVENT_END time.
DOM_INTERACTIVE
Type: Number
Description: The time in milliseconds when the page’s readyState is set to interactive. Indicates that the page has finished loading, but subresources, such as images and scripts, are still loading.
DOMAIN_LOOKUP_END
Type: Number
Description: The time in milliseconds when the browser completes a DNS lookup for a resource.
To calculate the DNS lookup time, subtract the DOMAIN_LOOKUP_START time from the DOMAIN_LOOKUP_END time.
DOMAIN_LOOKUP_START
Type: Number
Description: The time in milliseconds when the browser starts a DNS lookup for a resource.
To calculate the DNS lookup time, subtract the DOMAIN_LOOKUP_START time from the DOMAIN_LOOKUP_END time.
DURATION
Type: Number
Description: The total duration in milliseconds of the event from the START_TIME to the LOAD_EVENT_END time.
ENCODED_BODY_SIZE
Type: Number
Description: The size in octets of the HTTP message body before the removal of any applied content encoding.
EVENT_TYPE
Type: String
Description: The type of event. The value is always UITelemetryNavigationTiming.
FETCH_START
Type: Number
Description: The time in milliseconds when the browser starts to fetch a resource from the server, not including redirects. Occurs before the DNS lookup and the connection to the server is established.
To calculate the total time used to fetch a resource without redirects, subtract the FETCH_START time from the RESPONSE_END time.
FIRST_INTERIM_RESPONSE_START
Type: Number
Description: The time in milliseconds when the browser receives the first byte of the interim 1xx response from the server.
To calculate the time from when the browser sends a request to when it starts to receive an interim response, subtract the REQUEST_START time from the FIRST_INTERIM_RESPONSE_START time.
INITIATOR_TYPE
Type: String
Description: The HTML element that initiates the resource load.
Examples: css, image, link
LOAD_EVENT_END
Type: Number
Description: The time in milliseconds when the page’s load event handler completes.
To calculate the processing time for the load event handler, subtract the LOAD_EVENT_START time from the LOAD_EVENT_END time.
LOAD_EVENT_START
Type: Number
Description: The time in milliseconds when the page’s load event handler begins.
To calculate the processing time for the load event handler, subtract the LOAD_EVENT_START time from the LOAD_EVENT_END time.
LOGIN_KEY
Type: String
Description: The string that ties together all events in a user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
Example: GeJCsym5eyvtEK2I
NAVIGATION_TYPE
Type: String
Description: The type of navigation timing data.
Possible values:
navigate - A user interaction or a script initiated navigation.
reload - A reload initiated navigation.
back_forward - Navigation traverses the browser’s history.
prerender - A prerender hint initiated navigation.
NEXT_HOP_PROTOCOL
Type: String
Description: The Application-Layer Protocol Negotiation (ALPN) Protocol ID that fetches the resource.
Examples: http/0.9, http/1.0, h2, h2c, h3
ORGANIZATION_ID
Type: String
Description: The 15-character ID of the org.
Example: 00D000000000123
OS_NAME
Type: String
Description: The operating system name, derived from USER_AGENT.
Examples: Android, iOS, OSX
OS_VERSION
Type: String
Description: The operating system version, derived from USER_AGENT.
PAGE_CONTEXT
Type: String
Description: The name of the component hosting the main content of the page.
Example: clients:cardsContainer
PAGE_ENTITY_ID
Type: String
Description: The unique entity identifier of the event.
Example: 0013000000I3zJAAAZ
PAGE_ENTITY_TYPE
Type: String
Description: The entity type of the event.
Examples: task, contacts
PAGE_URL
Type: String
Description: The relative URL of the top-level Lightning Experience page that the user opened. The page can contain one or more Lightning components. Multiple record IDs can be associated with PAGE_URL.
Example: /sObject/0064100000JXITSAA5/view
REDIRECT_COUNT
Type: Number
Description: The total number of redirects since the last non-redirect navigation in the current browsing context.
REDIRECT_END
Type: Number
Description: The time in milliseconds when the browser receives the last byte of the response of the final redirect.
To calculate the total redirection time, subtract the REDIRECT_START time from the REDIRECT_END time.
REDIRECT_START
Type: Number
Description: The time in milliseconds when the browser starts to fetch a resource that initiates a redirect.
To calculate the total redirection time, subtract the REDIRECT_START time from the REDIRECT_END time.
RENDER_BLOCKING_STATUS
Type: String
Description: The status that indicates whether the resource can block or delay the browser from rendering page content.
Possible values:
blocking - The resource can block rendering.
non-blocking - The resource doesn’t block rendering.
REQUEST_ID
Type: String
Description: The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same REQUEST_ID.
Example: 3nWgxWbDKWWDIk0FKfF5DV
REQUEST_START
Type: Number
Description: The time in milliseconds when the browser starts to request the resource from the server.
To calculate the total request time, subtract the REQUEST_START time from the RESPONSE_START time.
RESPONSE_END
Type: Number
Description: The time in milliseconds when the browser receives the resource’s last byte or when the transport connection closes, whichever comes first.
To calculate the total time used to fetch a resource without redirects, subtract the FETCH_START time from the RESPONSE_END time.
RESPONSE_START
Type: Number
Description: The time in milliseconds when the browser receives the first byte of the response from the server.
To calculate the total request time, subtract the REQUEST_START time from the RESPONSE_START time.
RESPONSE_STATUS
Type: Number
Description: The HTTP response status code.
Example: 200
SDK_APP_TYPE
Type: String
Description: The mobile SDK application type.
Possible values:
HYBRID
HYBRIDLOCAL
HYBRIDREMOTE
NATIVE
REACTNATIVE
SDK_APP_VERSION
Type: String
Description: The mobile SDK application version number.
Example: 5.0
SDK_VERSION
Type: String
Description: The mobile SDK version number.
Example: 2.1.0
SECURE_CONNECT_START
Type: Number
Description: The time in milliseconds when the browser begins the handshake process that secures the connection.
To calculate the Transport Layer Security (TLS) time, subtract the SECURE_CONNECT_START time from the REQUEST_START time.
SERVER_REQUEST_ID
Type: String
Description: The request ID for the server request that’s used to find associated server logs.
Example: 346000000087551ecb
SESSION_KEY
Type: String
Description: The user’s unique session ID. You can use this value to identify all events in Lightning Experience within a session. When the user logs out and logs in again, a new session starts.
Example: cdd09305cb6babf34059e27f70e47f1b11dec868
START_TIME
Type: Number
Description: The time in milliseconds when the browser starts to fetch the resource, including redirects.
TIMESTAMP
Type: String
Description: The access time of Salesforce services in GMT.
Example: 20130715233322.670
TIMESTAMP_DERIVED
Type: DateTime
Description: The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ). The timezone is GMT.
Example: 2015-07-27T11:32:59.555Z
TRANSFER_SIZE
Type: Number
Description: The size in octets of the resource, including the response header and the response payload body.
UI_EVENT_RELATIVE_TIMESTAMP
Type: Number
Description: The difference in milliseconds between when the event is logged and when the browser tab is opened.
Example: 29322.23
UI_EVENT_TIMESTAMP
Type: Number
Description: The time at which this event occurs, measured in milliseconds.
Example: 1479769912796
UI_ROOT_ACTIVITY_ID
Type: String
Description: The ID of the root activity when the event occurs.
UI_THREAD_RESPONSE_DELAY
Type: Number
Description: The time in milliseconds from when the browser receives the response to when it executes the callback. This delay occurs if the main Javascript thread is busy when the response is received.
UNLOAD_EVENT_END
Type: Number
Description: The time in milliseconds when the page’s unload event handler completes.
To calculate the processing time for the unload event handler, subtract the UNLOAD_EVENT_START time from the UNLOAD_EVENT_END time.
UNLOAD_EVENT_START
Type: Number
Description: The time in milliseconds when the page’s unload event handler starts.
To calculate the processing time for the unload event handler, subtract the UNLOAD_EVENT_START time from the UNLOAD_EVENT_END time.
URL
Type: String
Description: The URL of the request.
USER_ID
Type: String
Description: The 15-character ID of the user accessing Salesforce services through the UI or API.
Example: 00530000009M943
USER_ID_DERIVED
Type: Id
Description: The 18-character case-insensitive ID of the user who’s using Salesforce services through the UI or the API.
Example: 00590000000I1SNIA0
USER_TYPE
Type: String
Description: The category of user license of the user accessing Salesforce services through the UI or API.
Possible values:
A - Automated Process
b - High Volume Portal
C - Customer Portal User
D - External Who
F - Self-Service
G - Guest
L - Package License Manager
N - Salesforce to Salesforce
n - CSN Only
O - Power Custom
o - Custom
P - Partner
p - Customer Portal Manager
S - Standard
X - Salesforce Administrator
WORKER_START
Type: Number
Description: If a service worker is installed, the time in milliseconds when the active service worker receives the fetch event.
To measure the service worker processing time, subtract the WORKER_START time from the FETCH_START time.