Newer Version Available

This content describes an older version of this product. View Latest

Lightning Page View Event Type

Lightning Page View events represent information about the page on which the event occurred in Lightning Experience and the Salesforce mobile app. A Lightning Page View event tracks the page a user visited, how long the user spent on the page, and the load time for the page. This event type is available in the EventLogFile object in API version 39.0 and later.

For details about event monitoring, see the Trailhead Event Monitoring module or REST API Developer’s Guide.

Fields

Field Details
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.
Example
Chrome, IE, Safari, Gecko
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 Salesforce Workbench or AppExchange) is shown as “Salesforce.com IP”.
For example: 96.43.144.26.
CONNECTION_TYPE
Type
String
Description
The type of connection.
Possible Values
  • CDMA1x
  • CDMA
  • EDGE
  • EVDO0
  • EVDOA
  • EVDOB
  • GPRS
  • HRPD
  • HSDPA
  • HSUPA
  • LTE
  • WIFI
DEVICE_ID
Type
String
Description
The unique identifier used to identify a device when tracking events. DEVICE_ID is a generated value that’s created when the mobile app is initially run after installation.
DEVICE_MODEL
Type
String
Description
The name of the device model.
Example
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
Id
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
DURATION
Type
Number
Description
The duration in milliseconds since the page start time.

This field is being deprecated. Use EFFECTIVE_PAGE_TIME instead.

Warning

EFFECTIVE_PAGE_TIME
Type
Double
Description
Indicates how many milliseconds it took for the page to load before a user could interact with the page’s functionality. Multiple factors can affect effective page time, such as network speed, hardware performance, or page complexity. If an effective page time greater than 60 seconds is detected, the value of this field is set to null or 0. In these cases, use the EFFECTIVE_PAGE_TIME_DEVIATION, EFFECTIVE_PAGE_TIME_DEVIATION_ERROR_TYPE, and EFFECTIVE_PAGE_TIME_DEVIATION_REASON fields to learn more about why pages take longer to load.
EFFECTIVE_PAGE_TIME_DEVIATION
Type
Boolean
Description
When a deviation is detected, EFFECTIVE_PAGE_TIME_DEVIATION records true. The default value is false.
EFFECTIVE_PAGE_TIME_DEVIATION_ERROR_TYPE
Type
String
Description
Indicates the origin of an error. This field is populated when EFFECTIVE_PAGE_TIME_DEVIATION_REASON contains the PAGE_HAS_ERROR value.
Possible Values
  • CUSTOM—An error originating from the customer's system or network.
  • SYSTEM—An error originating in Salesforce.
EFFECTIVE_PAGE_TIME_DEVIATION_REASON
Type
String
Description
The reason for deviation in page loading time.
Possible Values
  • PAGE_IN_DOM—The page was loaded from a cache.
  • PAGE_HAS_ERROR—An undefined page loading error occurred.
  • PAGE_NOT_LOADED—If a customer navigates away from a page while loading processes are in progress, the page doesn't finish loading.
  • PREVIOUS_PAGE_NOT_LOADED—When navigating to a new page, and the previous page hasn't completed loading, the next page is considered to have a deviation. Incomplete loading processes on a previous page can affect how the next page loads.
  • INTERACTIONS_BEFORE_PAGE_LOADED—A user interacts with a page element before the page is fully loaded.
  • PAGE_IN_BACKGROUND_BEFORE_LOADED—A background loading process runs on a page. Background processes can run when users don't interact with a page, such as when they navigate to another browser tab.
EVENT_TYPE
Type
String
Description
The type of event. The value is always LightningPageView.
GRANDPARENT_UI_ELEMENT
Type
String
Description
The grandparent scope of the page element where the event occurred.
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
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.
Example
Android, iOS, OSX, Windows
OS_VERSION
Type
String
Description
The operating system version, derived from USER_AGENT.
PAGE_APP_NAME
Type
String
Description
The internal name of the application that the user accessed from the App Launcher.
Example
LightningSales
PAGE_CONTEXT
Type
String
Description
The name of the component hosting the main content of the page.
Example
clients:cardsContainer
PAGE_ENTITY_ID
Type
Id
Description
The unique entity identifier of the event.
Example
0013000000I3zJAAAZ
PAGE_ENTITY_TYPE
Type
String
Description
The entity type of the event.
Example
Task, contacts
PAGE_START_TIME
Type
Number
Description
The time when the page was initially loaded, measured in milliseconds.
Example
1471564788642
PAGE_URL
Type
String
Description
Relative URL of the top-level Lightning Experience or Salesforce mobile app 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
PARENT_UI_ELEMENT
Type
String
Description
The parent scope of the page element where the event occurred.
PREVPAGE_APP_NAME
Type
String
Description
The internal name of the previous application that the user accessed from the App Launcher.
Example
LightningSales
PREVPAGE_CONTEXT
Type
String
Description
The context of the previous page where the event occurred.
Example
clients:cardsContainer
PREVPAGE_ENTITY_ID
Type
Id
Description
The unique previous page entity identifier of the event.
PREVPAGE_ENTITY_TYPE
Type
String
Description
The previous page entity type of the event.
Example
Task, contacts
PREVPAGE_URL
Type
String
Description
The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened.
Example
/sObject/006410000
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
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
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 is started.
Example
cdd09305cb6babf34059e27f70e47f1b11dec868
TARGET_UI_ELEMENT
Type
String
Description
The target page element where the event occurred.
Example
label bBody truncate, tabitem-link
TIMESTAMP
Type
String
Description
The access time of Salesforce services in GMT.
For example: 20130715233322.670.
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
For example: 2015-07-27T11:32:59.555Z. Timezone is GMT.
UI_EVENT_ID
Type
String
Description
Id of the Lightning event type.
Possible Values
  • ltng:error
  • ltng:interaction
  • ltng:pageView
  • ltng:performance
UI_EVENT_SEQUENCE_NUM
Type
Number
Description
An auto-incremented sequence number of the current event since the session started.
UI_EVENT_SOURCE
Type
String
Description
This field is being deprecated and is mostly null, except in mobile app views where it indicates the page type of views where the context is “native.”
UI_EVENT_TIMESTAMP
Type
Number
Description
The time at which this event occurred, measured in milliseconds.
Example
1479769912796
USER_AGENT
Type
String
Description
The numeric code for the type of client used to make the request (for example, the browser, application, or API) as a string.
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