UiAgentInteractionEventLog

This log tracks client side interactions and events with the Agentforce panel. It is limited to Salesforce Lightning Experience, Salesforce Mobile, and Conversation Preview within Agentforce Builder. This object is available in API version 65.0 and later.

Supported Calls

describeSObjects(), query()

Special Access Rules

To access this object, you must have the View Event Log Object Data user permission.

Fields

Field	Details
AgentType	Type string Properties Filter, Group, Nillable, Sort Description The type of agent.
AppName	Type string Properties Filter, Group, Nillable, Sort Description The app this logline has executed.
BotIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the agent.
BotSessionIdentifier	Type string Properties Filter, Group, Nillable, Sort Description Returned with every session (from bots runtime API). The session begins with co-pilot panel is opened and ends when the user logs out of Salesforce, closes the browser tab or exits the browser. For mobile, this id is present throughout the entire time the app is open, and only changes upon cold start or logout.
BrowserName	Type string Properties Filter, Group, Nillable, Sort Description The name of the browser.
BrowserVersion	Type string Properties Filter, Group, Nillable, Sort Description Browser major.minor version. Some browseers may not provide a minor version.
ButtonLabel	Type string Properties Filter, Group, Nillable, Sort Description When the user interacts with a message by clicking a message-level button, this is the label of the button the user selects.
Channel	Type string Properties Filter, Group, Nillable, Sort Description The name of the channel. For example, mobile, LEX, or Playground.
ClientGeolocation	Type string Properties Filter, Group, Nillable, Sort Description Client geographic location in format Country/State.
ClientIdentifier	Type string Properties Filter, Group, Nillable, Sort Description API client ID.
ClientIp	Type string Properties Filter, Group, Nillable, Sort Description Client IP address.
Components	Type textarea Properties Nillable Description An array of strings that contain the names of the components, including the namespace and the name of the component. This should include both input and output components.
ConnectionType	Type string Properties Filter, Group, Nillable, Sort Description The type of connection. For example, WiFi.
DeviceModel	Type string Properties Filter, Group, Nillable, Sort Description The device model.
DevicePlatform	Type string Properties Filter, Group, Nillable, Sort Description The application experience
DeviceSessionIdentifier	Type string Properties Filter, Group, Nillable, Sort Description Auto-generated ID on the client-side that stays the same for the duration of the browser tab.
FeedbackIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The turn ID from Agents V1 API.
HasToxicityWarning	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Flag to identify whether the message contains a toxicity warning. The default value is `false`.
IsAgentPanelExited	Type boolean Properties Defaulted on create, Filter, Group, Sort Description A boolean field that is true if the user clicks on a button to navigate away from an agent panel. The default value is `false`.
LightningType	Type textarea Properties Nillable Description An array of strings that contains the name of the ES type(s).
LightningTypeMessage	Type string Properties Filter, Nillable, Sort Description This is the ES type message associated with the co-pilot response (i.e. “Inform” or “Inquire”)
LoginKey	Type string Properties Filter, Group, Nillable, Sort Description The hash of the login id to allow tracking of all events from user login to logout.
MessageIdentifier	Type string Properties Filter, Group, Nillable, Sort Description Returned with every message (from bots runtime API).
MobileSdkAppType	Type string Properties Filter, Group, Nillable, Sort Description The mobile application type.
MobileSdkVersion	Type string Properties Filter, Group, Nillable, Sort Description The SDK version.
ObjectType	Type string Properties Filter, Group, Nillable, Sort Description The name of the object for ES Type recordInfo.
OperatingSystemName	Type string Properties Filter, Group, Nillable, Sort Description The name of the operating system.
OperatingSystemVersion	Type string Properties Filter, Group, Nillable, Sort Description The operating system version number.
PageContext	Type string Properties Filter, Group, Nillable, Sort Description Name of the component hosting the main content of the page.
PageObjectIdentifier	Type string Properties Filter, Group, Nillable, Sort Description Object id, if any, of the record being displayed.
PageObjectType	Type string Properties Filter, Group, Nillable, Sort Description Object type of the page being displayed.
PageUrl	Type string Properties Filter, Group, Nillable, Sort Description Raw url of the page log occurred on.
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.
SdkAppVersion	Type string Properties Filter, Group, Nillable, Sort Description The SDK app version this logline has executed.
SessionKey	Type string Properties Filter, Group, Nillable, Sort Description The hash of the session id to allow tracking of all events in a session.
TaskName	Type string Properties Filter, Group, Nillable, Sort Description This will describe the nature of the event being logged.
Timestamp	Type dateTime Properties Filter, Nillable, Sort Description Timestamp at which the log event was generated.
UiEventElapsedTime	Type double Properties Filter, Nillable, Sort Description The elapsed time for the UI event.
UiEventTimestamp	Type dateTime Properties Filter, Nillable, Sort Description Time when the message was logged according to the client.
UiRootActivityIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The ID for the root activity, if any, when this message was logged.
UserIdentifier	Type string Properties Filter, Group, Nillable, Sort Description The user ID of the request.
UserType	Type string Properties Filter, Group, Nillable, Sort Description The type of user.
VoiceOrText	Type string Properties Filter, Group, Nillable, Sort Description Whether the input by the user was “voice” or “text”.

Object Reference for the Salesforce Platform

UiAgentInteractionEventLog

Supported Calls

Special Access Rules

Fields