{ "sections": [ "title", "description", "fields", "special_access_rules" ], "title": "UiAgentInteractionEventLog - Data API", "description": "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.", "fields_columns": [ "type", "properties", "description" ], "fields": { "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”." } }, "special_access_rules": "To access this object, you must have the View Event Log Object Data user permission." }