LightningUriEventStream

Detects when a user creates, accesses, updates, or deletes a record in Lightning Experience only. This object is available in API version 46.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Streaming API (CometD)

Streaming API Subscription Channel

/event/LightningUriEventStream

Special Access Rules

Accessing this object requires either the Salesforce Shield or Salesforce Event Monitoring add-on subscription and the View Data Leakage Detection Events user permission.

LightningUriEventStream doesn’t track Setup events.

Note

Fields

Field	Details
AppName	Type string Properties Nillable Description The name of the application that the user accessed.
ConnectionType	Type string Properties Nillable Description The type of connection. Possible Values `CDMA1x` `CDMA` `EDGE` `EVDO0` `EVDOA` `EVDOB` `GPRS` `HRPD` `HSDPA` `HSUPA` `LTE` `WIFI`
DeviceId	Type string Properties Nillable 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.
DeviceModel	Type string Properties Nillable Description The name of the device model.
DevicePlatform	Type string Properties Nillable 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`
DeviceSessionId	Type string Properties Nillable 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.
Duration	Type double Properties Nillable Description The duration in milliseconds since the page start time.
EffectivePageTime	Type double Properties Nillable 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 0.
EventDate	Type dateTime Properties Nillable Description The time when the specified URI event was captured (after query execution takes place). For example, `2013-01-01T03:01:01Z`. Seconds are the most granular setting.
EventIdentifier	Type string Properties Nillable Description The unique ID of the event. For example, `0a4779b0-0da1-4619-a373-0a36991dff90`.
LoginKey	Type string Properties Nillable Description The string that ties together all events in a given user’s login session. The session starts with a login event and ends with either a logout event or the user session expiring.For example, 8gHOMQu+xvjCmRUt
Operation	Type picklist Properties Nillable, Restricted picklist Description The operation being performed on the entity. For example, `Read, Create, Update`, or `Delete`. Create and update operations are captured in pairs; that is, expect two event records for each operation. The first record represents the start of the operation, and the second record represents whether the operation was successful or not. The two records are correlated by RelatedEventIdentifier. If there isn’t a second event recorded for a create or update operation, then the user canceled the operation, or the operation failed with client-side validation (for example, when a required field is empty).
OsName	Type string Properties Nillable Description The operating system name.
OsVersion	Type string Properties Nillable Description The operating system version.
PageStartTime	Type dateTime Properties Nillable Description The time when the page was initially loaded, measured in milliseconds. Example `1471564788642`
PageUrl	Type url Properties Nillable 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 PageUrl. Example `/sObject/0064100000JXITSAA5/view`
PreviousPageAppName	Type string Properties Nillable Description The internal name of the previous application that the user accessed from the App Launcher.
PreviousPageEntityId	Type string Properties Nillable Description The unique previous page entity identifier of the event.
PreviousPageEntityType	Type string Properties Nillable Description The previous page entity type of the event.
PreviousPageUrl	Type url Properties Nillable Description The relative URL of the previous Lightning Experience or Salesforce mobile app page that the user opened. Example `/sObject/006410000`
QueriedEntities	Type string Properties Nillable Description The API name of the objects referenced by the URI.
RecordId	Type string Properties Nillable Description The id of the record being viewed or edited. For example, `001RM000003cjx6YAA`.
RelatedEventIdentifier	Type string Properties Nillable Description Represents the EventIdentifier of the related event.
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
SdkAppType	Type string Properties Nillable Description The mobile SDK application type. Possible Values `HYBRID` `HYBRIDLOCAL` `HYBRIDREMOTE` `NATIVE` `REACTNATIVE`
SdkAppVersion	Type string Properties Nillable Description The version of the mobile SDK the application uses.
SdkVersion	Type string Properties Nillable Description The mobile SDK application version number. Example 5.0
SessionKey	Type string Properties Nillable Description The user’s unique session ID. Use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
SessionLevel	Type picklist Properties Nillable, Restricted picklist Description Reserved for future use.
SourceIp	Type string Properties Nillable Description The source IP address of the client logging in. For example, `126.7.4.2`.
UserId	Type reference Properties Nillable Description The user’s unique ID. For example, `005RM000001ctYJYAY`.
Username	Type string Properties Nillable Description The username in the format of `user@company.com` at the time the event was created.
UserType	Type picklist Properties Nillable, Restricted picklist Description The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. Valid values are: `CsnOnly`—Users whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. `CspLitePortal`—CSP Lite Portal license. Users whose access is limited because they are organization customers and access the application through a customer portal or community. `CustomerSuccess`—Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal. `Guest` `PowerCustomerSuccess`—Power Customer Success license. Users whose access is limited because they are organization customers and access the application through a customer portal. Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the customer portal role hierarchy. `PowerPartner`—Power Partner license. Users whose access is limited because they are partners and typically access the application through a partner portal or community. `SelfService` `Standard`—Standard user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses.

Platform Events Developer Guide