afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/UiTelemetryNavTmEventLog.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules"
  ],
  "title": "UiTelemetryNavTmEventLog - Data API",
  "description": "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 64.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "possible_values"
  ],
  "fields": {
    "AppName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the application that the user accessed."
    },
    "BrowserName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the browser that the user accessed."
    },
    "BrowserVersion": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The version of the browser that the user accessed in major.minor version format. Some browsers don’t provide a minor version."
    },
    "ClientGeolocation": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The geolocation of the client in the form of <Country>/<State|Province>."
    },
    "ClientIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort"
    },
    "ClientIp": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "ConnectEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "ConnectStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "ConnectionType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The type of connection."
    },
    "DecodedBodySize": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The size in octets of the HTTP message body after the removal of any applied content encoding."
    },
    "DeviceModel": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the device model."
    },
    "DevicePlatform": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The type of application experience in name:experience:form format."
    },
    "DeviceSessionIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "DomComplete": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "DomContentLoadedEventEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "DomContentLoadedEventStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "DomInteractive": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "DomainLookupEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "DomainLookupStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The total duration in milliseconds of the event from the START_TIME to the LOAD_EVENT_END time."
    },
    "EncodedBodySize": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The size in octets of the HTTP message body before the removal of any applied content encoding."
    },
    "FetchStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "FirstInterimResponseStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "InitiatorType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The HTML element that initiates the resource load."
    },
    "LoadEventEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "LoadEventStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "LoginKey": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "MobileSdkAppType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The mobile application type."
    },
    "MobileSdkVersion": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Mobile SDK version number."
    },
    "NavigationType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "NextHopProtocol": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The Application-Layer Protocol Negotiation (ALPN) Protocol ID that fetches the resource.",
      "possible_values": "http/0.9, http/1.0, h2, h2c, h3"
    },
    "OperatingSystemName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The operating system name, derived from USER_AGENT."
    },
    "OperatingSystemVersion": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The operating system version, derived from USER_AGENT."
    },
    "PageContext": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the component hosting the main content of the page."
    },
    "PageObjectIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The unique object identifier of the event."
    },
    "PageObjectType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The object type of the event."
    },
    "PageUrl": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "RedirectCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The total number of redirects since the last non-redirect navigation in the current browsing context."
    },
    "RedirectEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "RedirectStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "RenderBlockingStatus": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The status that indicates whether the resource can block or delay the browser from rendering page content."
    },
    "RequestIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "RequestStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "ResponseEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "ResponseStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "ResponseStatus": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The HTTP response status code."
    },
    "SdkAppVersion": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The mobile SDK application version."
    },
    "SecureConnectionStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The time in milliseconds when the browser begins the handshake process that secures the connection."
    },
    "ServerRequestIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The request ID for the server request that’s used to find associated server logs."
    },
    "SessionKey": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "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."
    },
    "StartTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The time in milliseconds when the browser starts to fetch the resource, including redirects."
    },
    "Timestamp": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The access time of Salesforce services in GMT."
    },
    "TransferSize": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The size in octets of the resource, including the response header and the response payload body."
    },
    "UiEventElapsedTime": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The difference in milliseconds between when the event is logged and when the browser tab is opened."
    },
    "UiEventTimestamp": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The time at which this event occurs, measured in milliseconds."
    },
    "UiRootActivityIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the root activity when the event occurs."
    },
    "UiThreadResponseDelay": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "UnloadEventEnd": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    },
    "UnloadEventStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The URL of the request."
    },
    "UserIdentifier": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The 15-character ID of the user accessing Salesforce services through the UI or API."
    },
    "UserType": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The category of user license of the user accessing Salesforce services through the UI or API."
    },
    "WorkerStart": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "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."
    }
  },
  "special_access_rules": "To access this object, you must have the View Event Log Object Data user permission."
}