BMC Helix Virtual Agent reporting events


The usage metrics help you understand how end users are using the chatbot application, derive statistics about a successful or unsuccessful event, and so on. You can use the out-of-the-box events and reports, specify new events and generate reports, or enable or disable events for tracking. By default, the username and event creation date attributes are tracked. You cannot modify or delete these attributes.


Important

The reports are meant for tracking the chatbot usage and only aggregated data is available to generate reports. To create reports for raw events in the Telemetry service, see Creating-reports-for-raw-events-in-the-Telemetry-service.

Chatbot events, event statistics, and reports

The following table lists the out-of-the-box events, event statistics, and reports: 

Event name and description

Event attributes

Event statistics 

Reports and examples

Service Request

(When a service request is successfully submitted from the BMC Helix Virtual Agent)

  • ServiceName
  • Channel
  • CreatedDate
  • BotID
  • BotName
  • SuccessOrFailure
  • ReasonForFailure
  • UserName
  • SessionId
  • Service Request By Bot Id
  • Service Request By Bot Id and Channel
  • Service Request By ServiceName
  • Service Request By SessionId


  • Service Request By Bot ID
  • Service Request By Channel

Example of the Service Request report

report_service_requests.png

Successful transfer to agent

(When the end user's request to transfer the chat to a live agent is successful)

  • UserSummary
  • TopicName
  • intentMatchedRootSonDialogNode
  • UserName
  • BotName
  • SessionDuration
  • CreatedDate
  • AgentName
  • LiveAgentSessionEndTime
  • Channel
  • BotID
  • LiveAgentSessionStartTime
  • SessionId
  • Location
  • SupportQueueName
  • Successful Transfer to Agent By Bot Id
  • Successful Transfer to Agent By Bot Id And Channel

  • Successful Transfer to Agent By Bot Id
  • Successful Transfer to Agent By Channel
Example 1 of the Successful Transfer to Agent report

report_successful_transfer.png

Example 2: Containment report of the Successful Transfer to Agent report.

Failed transfer to agent

(When the end user's request to transfer the chat to a live agent fails)

  • ReasonForFailure
  • User
  • Channel
  • CreatedDate
  • BotID
  • BotName
  • SessionId
  • Failed Transfer to Agent By Bot Id
  • Failed Transfer to Agent By Bot Id and Channel
  • Failed Transfer to Agent By Bot Id
  • Failed Transfer to Agent By Channel
Example of the Failed Transfer to Agent report

report_failed_transfer.png

Example 2: Containment report of the Successful Transfer to Agent report

Failed entitlements check

(When an entitlements check fails)

  • Itemthatwasbeingchecked
  • User
  • Channel
  • CreatedDate
  • BotID
  • BotName
  • Failed Entitlement Check by Bot Id
  • Failed Entitlement Check By Channel
  • Failed Entitlement Check by Bot Id
  • Failed Entitlement Check By Channel
Example of the Failed Entitlement Check report

report_failed_entitlements.png

User Feedback

(When the user rating and survey comments are successfully entered from BMC Helix Virtual Agent. The localization of the user feedback customer survey text is based on the survey dialogs of the IBM Watson Assistant Skill and the corresponding entities.)

  • UserName
  • CreatedDate
  • BotID
  • BotName
  • Channel
  • Rating
  • SessionId
  • Comment
  • Location
  • User Feedback By Bot Id and Channel
  • User Feedback By Bot Id
  • User Feedback By Channel
  • User Feedback By Bot Id and Rating
  • User Feedback By Bot Id_Comments_Rating


GPT Feedback

(When the user feedback and comments on the BMC HelixGPT responses are successfully entered from BMC Helix Virtual Agent. The GPT Feedback event is pushed to the Telemetry. When feedback on multiple responses are returned, each one is pushed as a separate event to the Telemetry.)

  • UserName
  • CreatedDate
  • SessionId
  • Comment
  • Useful
  • PromptId
  • Request
  • SkillId
  • AppName
  • Response
  • GPT feedback by All
  • GPT Feedback by SkillId and PromptId and Rating and AppName and SessionId

Conversation

(When the count of unique users, conversations, conversations per channel, total number of answered or unanswered questions, top intents, knowledge search, and session time is successfully captured).

  • UserName
  • Locale
  • BotId
  • BotName
  • CreatedDate
  • Channel
  • SessionId
  • Location
  • Intent
  • UserText
  • KnowledgeUserSearchText
  • KnowledgeNumberOfArticles
  • KnowledgeArticlesDetails
  • SessionStartTime
  • SessionEndTime
  • SessionIdleTime
  • ConversationDuration
  • ResolutionStatus
  • NumOfResponses
  • DialogStatus
  • AverageResponseTimeInSec
  • UserExceededIdleTime
  • ConversationLocale
  • EventType
  • ChatWebGUID (ID when Chatbot Web UI is used, channel name if a chat channel is used)
  • Conversation By Bot Id and User Name
  • Conversation by Bot Id and Channel
  • Conversation by Bot Id and Intent

Bot Transform

(When a transfer occurs from one chatbot to the another)

  • Question
  • TransformBotName
  • CreatedDate
  • TransformSessionId
  • UserName
  • SessionId
  • TransformBotId
  • BotId
  • BotName


Example not available

Article Clicked

(An Article Clicked event occurs when the user clicks the searched knowledge article. The Article Clicked event is pushed to the Telemetry immediately after the user clicks the searched knowledge article.)

  • BotId
  • ArticleId
  • SessionId
  • UserName
  • CreatedDate
  • ArticleTitle
  • Confidence
  • BotName

Article Clicked by ArticleId and ArticleTitle

Article Clicked by ArticleId and ArticleTitle_ReportData

Example not available

Article Rated

(An Article Rated event occurs when the user rates the searched knowledge article. The Article Rated event is pushed to the Telemetry only after the browser is refreshed or closed. If the user has rated multiple knowledge articles before they refresh or close the browser, each article that is rated is pushed as a separate event to the Telemetry.)

  • ArticleRate
  • ArticleId
  • BotId
  • BotName
  • Confidence
  • ArticleTitle
  • UserName
  • CreatedDate
  • SessionId

Article Rated by ArticleId and ArticleTitle

Article Rated by ArticleId and ArticleTitle_ReportData

Example not available

Knowledge Search 

(A Knowledge Search event occurs when the user search returns knowledge articles. The Knowledge Search event is then pushed to the Telemetry. When multiple knowledge articles are returned, each one is pushed as a separate event to the Telemetry.)

  • Confidence
  • UserName
  • SearchEventId
  • CreatedDate
  • SessionId
  • BotId
  • SearchKeyword
  • SearchProvider
  • ArticleId
  • BotName
  • ArticleTitle

Knowledge Search by ArticleId and ArticleTitle

Knowledge Search by ArticleId and ArticleTitle_ReportData

Example not available


Chat count reports

In addition to the application usage reports, BMC Helix Innovation Suite provides the following reports:

Report

Description

Example

Chat count By Bot Id

Report for number of cognitive service chat conversations by Bot Id.

This report helps administrators see how much capacity each chatbot is using and whether to buy more chat capacity. 

report_comsumption_bot_id.png

Chat Count by Locale

Report for number of conversations per chatbot per locale.

This report helps administrators decide whether to buy more chat capacity, which chatbot language is being used, and so on

RTT Report_ conversations per bot per language.png

Conversations count by channel

Report for the distribution of conversations per channel used by the customer.

OOTBD-conversation-count-by-channel.png

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*