Newer Version Available

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

Lightning Interaction Event Type

Lightning Interaction events track user actions in Lightning Experience and the Salesforce mobile app, such as the user clicking, tapping, or scrolling on a 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_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”.
Example
96.43.144.26
COMPONENT_NAME
Type
String
Description
The internal name of the standard component that the user interacted with. The Salesforce developer assigned the name when the standard component was created.
Examples
  • SaveEdit
  • Lead.CCPM_sendSMS
  • ChangeOwnerOne
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.
EVENT_TYPE
Type
String
Description
The type of event. The value is always LightningInteraction.
GRANDPARENT_UI_ELEMENT
Type
String
Description
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
Context of the page where the event occurred.
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
Parent scope of the page element where the event occurred.
RECORD_ID
Type
String array
Description
The IDs of one or more records that the user interacted with. For more information on the user interaction, see UI_EVENT_TYPE and UI_EVENT_SOURCE fields.
Example
["5004100000JaGGLAA3", "5004100000Dn79CAAR", "50041000007KeugAAC"]
RECORD_TYPE
Type
String
Description
The type of record object that the user interacted with.
Examples
  • Account
  • Opportunity
RELATED_LIST
Type
String
Description
The type of related list that the user clicked.
Example
Opportunity
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.
Example
20130715233322.670
TIMESTAMP_DERIVED
Type
DateTime
Description
The access time of Salesforce services in ISO8601-compatible format (YYYY-MM-DDTHH:MM:SS.sssZ).
Example
2015-07-27T11:32:59.555Z
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
The user action on the record or records in RECORD_ID. This field’s value indicates whether the user’s action was on a single record or multiple records. For example, read indicates that one record was read (such as on a record detail page); reads indicates that multiple records were read (such as in a list view).
Examples
  • click
  • create
  • delete
  • hover
  • read
  • update
UI_EVENT_TIMESTAMP
Type
Number
Description
The time at which this event occurred, measured in milliseconds.
Example
1479769912796
UI_EVENT_TYPE
Type
String
Description
The type of interaction with the records in RECORD_ID.
Examples
  • crud — Created, read, updated, or deleted the record.
  • reads — Read multiple records.
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