You are here:
Bot Data Reference Guide
A list of bot objects, events, and fields to use when you troubleshoot, develop, or build Einstein Bots.
Required Editions
| View supported editions. |
Bot Entity Reference
A junction record between bot sessions and bot events.
| Bot Event Label | Definition |
|---|---|
| BotDefinition | The name of the bot. |
| BotVersion | The version of the bot. |
| ConversationDefinitionDialog | A dialog inside a bot version. |
| ConversationDefinitionSession | A bot session. |
| ConversationDefinitionSessionEngagement | A junction object between a Conversation Definition Session and the corresponding Conversation engagements for the session. |
| ConversationDefinitionEventLog | Stores actions performed by the automated conversation runtime for user troubleshooting and analysis. |
Conversation Definition Session
A record generated with each bot session. This data is deleted after seven days.
| Field | Definition |
|---|---|
| Channel Type | The type of channel in the session. Examples: Chat, Custom |
| Conversation Definition | The 15-digit ID of the bot version associated with the session. |
| Conversation Definition Session ID | The 15-digit ID of the session. |
| Has Error Logs | Identifies whether the session includes an error event. |
| Hour | The hour related to the record (0-23). |
| Integration Name | The name of the external connection to the bot. |
| Integration Type | The type of external connection to the bot. Example: API |
| Session Duration | The time of the session in milliseconds. |
| Session End Type | The way that the session ended. Examples: Ended by End User, Transferred, Session Timed Out, Error, Action, Other |
| Session Start Time | The start date and time of the session. |
| Session Status | The status of the session. Example: Ended |
| Session Transfer Result | If a transfer was initiated, the status of the transfer. Examples: Transfer Successful, Transfer Failed, No Transfer Requested, No Agents Available |
| Session Transfer Target Type | The destination of the transfer: Service Rep or Bot |
| Session Transfer Type | The origin of the request to transfer. Examples: Bot Request, Implementation Error, Invocation Timeout, Insufficient Privileges |
| Was Session Engaged | Indicates whether a bot session is engaged (true) or not (false). The default is false. An engaged session is a session in which a user sends at least one message or clicks at least one menu option or choice. In a bot-to-bot transfer, a session is considered engaged when a user interacts with at least one of the bots. |
Conversation Definition Event Log
A record of the events that occur in a bot session, including actions the bot takes interacting with the user and further processing steps. This data is deleted after seven days.
| ChannelType | The type of channel in the session. Example: Chat |
| ConversationDefinition | The ID of the bot version associated with this event log. |
| ConversationTurn | The UUID of the conversation turn. |
| DialogDefinition | The ID of the dialog associated with this event log. |
| EventDetails | Contains details about NLP/ELU events. |
| EventLabel | The description of the event log that shows up in the Performance Tab. |
| EventTarget | The enum or ID of the event target. Example: Dialog ID |
| EventTargetType | The target type of the event log. Example: Apex, Flow |
| EventTimestamp | The timestamp of the event log. |
| EventUuid | The 32-character UUID associated with this event log. |
| Language | The selected language for the bot. A bot with one language shows the language set on the Bot Overview page, and a bot with multiple languages starts with the primary language and then updates to the selected secondary language. |
| LogLevel | The level of the event log. Example: Debug, Info |
| LogType | The type of the event log. Example: StartSession PlannerInvalidAction: Logged when the planner attempts to execute an invalid or unsupported action during a conversation definition step or runtime step. ResponseEvaluationMetric: Logged when a response evaluation metric is recorded for a model output, such as factuality or rubric-based scoring. |
| Parent | The ID of the session associated with this event log. |
| PreviousEventLog | The ID of the previous event log. |
| PreviousEventLogUuid | The EventUuid of the previous event log. |
| StepDefinition | The ID of the dialog step associated with this event log. |
| StepType | The type of the dialog step. Example: Transfer |
Conversation Definition Dialog Daily Metrics
A record of bot metrics by day for reporting over time.
| Field | Definition |
|---|---|
| Article | The ID of the selected knowledge article. |
| ArticleName | The title of the selected knowledge article. |
| BotDefinitionName | The name of the bot. |
| BotVersionID | The version number of the bot. |
| ChannelType | The type of channel in the session. Example: Chat |
| ConversationDefinitionId | |
| DialogDefinition | The 15-digit ID of the dialog. |
| DialogDefinitionName | The name of the dialog. |
| DialogEntryPoint | The number of entry points for a given dialog. Entry points are the mode by which a user entered a given dialog, inluding User Navigation, Rule Action, Dialog Next Step, and Intent Detection. |
| GoalName | The name of an admin-defined goal that’s been reached by a user. |
| IntegrationName | The name of the external connection to the bot. |
| IntegrationType | The type of external connection to the bot. Example: API, Slack |
| Intent Label | The name of the intent. |
| IsSuccessful | A boolean field identifying the success or failure of an action if the metric type refers to an action that could fail. |
| Language | The selected language for the bot. A bot with one language shows the language set on the Bot Overview page, and a bot with multiple languages starts with the primary language and then updates to the selected secondary language. |
| MetricDateTime | The date the metric was logged. |
| MetricType | The type of metric logged. Examples: Escalation, Exception, Cancel Dialog, Dialog Opened, Dialog Complete, Confusion, Choice Selected, Sessions Started, Action Executed, Sessions Ended, NLP Intent Called, Transferred, Goal Completed, Sessions Engaged |
| SessionEndType | Categorizes the way the conversation session ended. Examples: Action, Ended By End User, Error, Other, Session Timed Out, or Transferred. |
| SessionTransferType | The origin of the request to transfer. Examples: Bot Request, Implementation Error, Invocation Timeout, Insufficient Privileges |
| StaticChoiceValue | The text of the static choice selection by the user. |
| Value | The value of the metric. Example: If 20 bot sessions started in the last month, the Metric Type would be Sessions Started and the Value would be 20. |
Conversation Definition Dialog Hourly Metrics
A record of bot metrics by hour for reporting over time.
| Field | Definition |
|---|---|
| Article | The ID of the selected knowledge article. |
| ArticleName | The title of the selected knowledge article. |
| BotDefinitionName | The name of the bot. |
| BotVersionID | The version number of the bot. |
| ChannelType | The type of channel in the session. Example: Chat |
| DialogDefinition | The 15-digit ID of the dialog. |
| DialogDefinitionName | The name of the dialog. |
| DialogEntryPoint | The number of entry points for a given dialog. Entry points are the mode by which a user entered a given dialog, inluding User Navigation, Rule Action, Dialog Next Step, and Intent Detection. |
| Goal Name | The name of an admin-defined goal that’s been reached by a user. |
| Hour | The hour related to the record (0-23). |
| IntegrationName | The name of the external connection to the bot. |
| IntegrationType | The type of external connection to the bot. Example: API, Slack |
| IntentLabel | The name of the intent. |
| IsSuccessful | A boolean field identifying the success or failure of an action if the metric type refers to an action that could fail. |
| Language | The selected language for the bot. A bot with one language shows the language set on the Bot Overview page, and a bot with multiple languages starts with the primary language and then updates to the selected secondary language. |
| MetricDateTime | The date and time the metric was logged. |
| MetricType | The type of metric logged. Examples: Action Executed, Escalation, Exception, Cancel Dialog, Dialog Opened, Dialog Completed, Confusion, Choice Selected, Goal Completed, Sessions Started, Sessions Engaged, Sessions Ended, NLP Intent Called, Transferred. |
| SessionEndType | Categorizes the way the conversation session ended. Examples: Action, Ended By End User, Error, Other, Session Timed Out, or Transferred. |
| SessionTransferType | The origin of the request to transfer. Examples: Bot Request, Implementation Error, Invocation Timeout, Insufficient Privileges |
| StaticChoiceValue | The text of the static choice selection by the user. |
| Value | The value of the metric. Example: If 20 bot sessions started in the last month, the Metric Type would be Sessions Started and the Value would be 20. |
Conversation Definition Session Metric
A record of bot metrics by session. This data is deleted after 180 days.
| Field | Definition |
|---|---|
| ArticleChosenCount | The number of articles the end user selected inside a session. |
| ChoiceSelectionCount | The total number of choices the end user selected inside a session, including static choices in questions and choices from the Main Menu. |
| GlobalChoiceSelectionCount | The number of choices the end user selected inside a session from the Options Menu. |
| InputMessageCount | The number of messages sent by the end user to the bot. |
| InterruptedDialogCount | The number of dialogs where the end user chose to exit the dialog. Methods include selecting from the Options Menu or entering text that matches an intent. |
| LastDialog | The 15-digit ID of the last visited dialog when the bot session ended. |
| LastDialogName | The name of the last visited dialog when the bot session ended. |
| NlpIntentRequestCount | The number of text inputs sent for intent matching. |
| NlpIntentRequestHitCount | The number of text inputs with a successful intent match. |
| OutputMessageCount | The number of messages sent by the bot to the end user. |
| StartedDialogCount | The number of dialogs started inside the session. |
| TransferWaitTime | Duration in seconds between the user requesting a transfer and a service rep accepting the transfer. |
| WasSessionDropped | Identifies whether the session was dropped. |
Event Log: List of Events
A record created each time an event occurs in a bot session. This data is deleted after seven days.
| Level | Event | Description |
|---|---|---|
| Debug | Initializing context variable: | The bot is accessing a context variable. |
| Error | Error: | An error has occurred. |
| Error | Invocation failed - errors: | The bot invoked a flow or Apex but there were errors. |
| Error | Transfer failed: | The transfer failed. |
| Info | Call dialog: | The bot called a dialog. |
| Info | Clear Variable: | The bot used the Clear Variable Value dialog. The Variable Name is included in the event log. |
| Info | Disambiguation process complete | The disambiguation process was completed. |
| Info | ELU call failed | The ELU call failed. |
| Info | ELU call successful | The ELU call succeeded. |
| Info | End chat requested | The bot ended the chat. |
| Info | End dialog: | The end of a dialog. |
| Info | Entity extracted | The bot was able to successfully extract an entity. |
| Info | Escalation requested | An escalation to a service rep was requested. |
| Info | External entities extracted | The bot was able to successfully extract an entity from an external source. |
| Info | External intents detected | The bot detected intents from an external source. |
| Info | Feedback: | The user provided feedback indicating whether the knowledge article presented was useful. |
| Info | GoalAchieved: | The user reached an admin-defined goal. |
| Info | Intent detected successfully: | The bot was able to identify an intent. |
| Info | Intent detection failed | The bot wasn’t able to identify an intent. |
| Info | Invocation failed - errors: | The bot failed to invoke a flow or Apex. |
| Info | Invocation successful: | The bot was able to invoke a flow or Apex. |
| Info | Language | The selected language for the bot. A bot with one language shows the language set on the Bot Overview page, and a bot with multiple languages starts with the primary language and then updates to the selected secondary language. |
| Info | Language changed from {0} to {1} | The selected language for the bot was changed from the original language to a different language. |
| Info | Match found: | The bot was able to match an ELU intent, entity, or boolean extraction. |
| Info | Message component sent: | An enhanced messaging component was sent to a user. |
| Info | Message sent: | A message sent to a user. |
| Info | No match found: | The bot was unable to match an ELU intent, entity, or boolean extraction. |
| Info | Out of domain | The bot was unable to match an intent. |
| Info | Prompt sent: | A question sent to a user. |
| Info | Redirect to dialog: | The bot redirected to a dialog. |
| Info | Rule condition evaluation | The bot is evaluating the user input based on the rule conditions. |
| Info | Rule condition item result: False | The bot evaluated the user input based on the rule conditions and found it to not meet those conditions. |
| Info | Rule condition item result: True | The bot evaluated the user input based on the rule conditions and found it to meet those conditions. |
| Info | Search failed - errors: | The bot performed a search and encountered an error. |
| Info | Search successful | The bot performed a search and was successful. |
| Info | Sensitive data not available | This event shows when the “Store Einstein Bots conversation data” isn’t checked. |
| Info | Session ended | The bot session ended. |
| Info | Set Variable | The bot used the Set Variable dialog. The Variable Name is included in the event log. |
| Info | Start dialog: | The start of a new dialog. |
| Info | Start disambiguation process | The start of the disambiguation dialog. |
| Info | Starting a new session | The bot is starting a new session. |
| Info | Static choice selected | The user selected a static choice presented by the bot. |
| Info | Transfer successful: | The transfer was successful. |
| Info | Transferred from bot: | The conversation started with a bot transfer. |
| Info | User response: | The response from the user. |
| Info | User sent a file | The user sent a file. |
| Info | Variable already filled: | The bot tried to enter data into a variable but it was already filled. |
Aggregate Metrics
The following fields are calculations used to generate aggregate metrics. Aggregate fields source data from event actions inside the session, which show up as events in the event logs. To learn more about an aggregate by a specific value, such as by bot or by channel, use aggregate groupings.
| Aggregation | Event | Action |
|---|---|---|
| AllELUCalled | ELU call | An ELU call was made. |
| ArticleChosen | Article chosen | An article was chosen. |
| ArticleFeedbackCount | Article feedback count | The total count of article feedback scores. |
| ArticleFeedbackSum | Article feedback sum | The sum value of article feedback scores. |
| CancelDialog | Dialog canceled | A dialog was canceled by the user. |
| ChoiceSelected | User response | The static choice selected by the end user. |
| CompletedGoalSession | Completed goal session | The user completes at least one admin-defined goal in the session. |
| Confusion | Intent detection failed | The bot is unable to identify an intent from the end-user input. |
| DialogCompleted | End dialog | A completed dialog that has run through all dialog steps. |
| DialogOpened | Call dialog, Redirect to dialog, Start dialog | A dialog opened in a session, including calls and redirects. |
| ELUBooleanExtracted | ELU boolean extracted | An ELU boolean was detected by the bot. |
| ELUEntityCalled | ELU entity called | An ELU entity was detected by the bot. |
| ELUIntentCalled | ELU intent called | An ELU intent was detected by the bot. |
| Escalation | Escalation requested | A user requests a transfer or a bot encounters an error in a session. |
| Exception | Error, Invocation failed - errors | A mid-session error. |
| FailedTransferSession | Transfer failed | A transfer attempt failed. |
| GoalAchieved | Goal completed | The user completed an admin-defined goal. |
| NLPIntentCalled | Intent detected successfully, Intent detection failed | A request to the internal or external NLP system. |
| SessionsEnded | Session ended | An ended session, by both the user and the bot. |
| SessionsStarted | Starting a new session | A bot session starts. |
| Transferred | Transfer failed or Transfer successful | Any transfer request. |
