Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Design
Develop
Dialog Task
Working with User Intent Node
Working with the Dialog Node
Working with Entity Node
Supported Entity Types
Working with Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Working with Message Nodes
Working with the Confirmation Nodes
Working with Service Node
Implementing Custom Authentication
Enabling 2-way SSL for Service nodes
Working with Script Node
Working with Agent Transfer Node
Working with WebHook Node
Defining Connections & Transitions
Managing Dialogs
Prompt Editor
Action & Information Task
Working with Action Tasks
Working with Information Tasks
Establishing Flows
Alert Tasks
Working with Alert Tasks
Managing Ignore Words and Field Memory
Knowledge Graph
Terminology
Building Knowledge Graph
Generation of Knowledge Graph
Importing and Exporting Knowledge Graph
Knowledge Graph Analysis
Knowledge Extraction
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
NLP Settings and Guidelines
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talking to Bot
Utterance Testing
Batch Testing
Recording Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Defining
Creating
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Kore.ai Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Web Socket Connect & RTM
Using the BotKit SDK
Installing the BotKit SDK
BotKit SDK Configuration
Events for the BotKit SDK
Functions for the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Overview
Using Single Sign-On
Cloud Connector
Analytics
Billing
Bot Store
Overview
Creating a Kore.ai Bot Account
Adding a Kore.ai Bot
Choosing a Channel for a Bot
Interacting with a Kore.ai Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Kore.ai Webhook Bot
Custom Kore.ai Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Kore.ai Support
Setting Up Filters
Bot Store Settings
How Tos
Context Switching
Using Traits
Live Agent Transfer
Schedule a Smart Alert
Configure Agent Transfer
Custom Dashboard
  1. Home
  2. Docs
  3. Bots
  4. Analyzing Your Bot
  5. Custom Dashboard

Custom Dashboard

Custom Dashboards allow you to design your own reports and dashboards to meet business needs using a combination of built-in metrics as well as custom KPIs based on user demographic or context information.

Custom Dashboards are in addition to the out-of-the-box dashboard reports available in the Bot Builder. See here for more on the Default Dashboard.

This feature was introduced in the ver7.1 of the platform.

Custom Dashboards can be built using the following three simple steps:

  1. Identify the data points that you need to capture for deriving the metrics. This will be based on your business requirements and needs.
  2. Define suitable Custom Meta Tags to emit these data points in the Bot definition. See here for how to add custom meta tags to your bot.
  3. Design widgets, preview and update the dashboard with these widgets. The rest of this document walks you through this step,

You can use the Custom Dashboards under Dashboard from the Left Navigation Menu to add multiple custom dashboards for your bot.

  • Each of these dashboards can have one or more widgets.
  • Each of these widgets can be associated with a set of predefined datasets.
  • Datasets can be used to define queries (similar to SQL) for extracting the required data to be represented by the widgets.
  • Information related to messages, sessions, analytics and meta tags can be used to generate the data.

We will be seeing how to build a Custom Dashboard using each of the above-mentioned components.

Dashboards

You can add one or more Dashboards by providing basic details of the Dashboard.

  • Every Dashboard comes with ‘Date Range’ as a default filter and this will be applicable for all widgets in the Dashboard.
  • You can Add Widget to a given Dashboard (see below for details).
  • You can reorder the widgets within a dashboard using the move cursor, visible on mouse hover over the widget, to drag and reorder the widget anywhere on the Dashboard.
  • You can edit and modify the Dashboard Name anytime.
  • Using the more (verticle ellipses) icon, you can either create a New DashboardClone DashboardExport Dashboard or Delete Dashboard.
  • Dashboard can be exported as PDF or the dashboard data can be exported in JSON format.

Widgets

You can add one or more widgets to a Dashboard. Use the Add Widget option to add widgets to a Dashboard. Widget configuration involves two steps:

  1. Data Definition, and
  2. Data Representation.

Data Definition

Every widget should be assocaited with a query definition to specify what information should be retrieved and represented on a Widget. Following are the configurations used to generate the query definition:

  • Dataset defining the source of data. This can be:
    • Analytics: Analytics gives access to data pertaining to Success Intents, Failed Intents, Success Tasks and Failed Tasks associated with your bot. You can choose to view key fields like MetricType, Channel, UserId, etc. or any custom fields added against the metrics records.
    • Message: This dataset provides Bot and User messages for your Bot. You can choose to view key fields UserId, Channel, etc. or any custom fields added against the messages.
    • Sessions: Use this dataset to provide a listing of conversation sessions associated with your Bot. You can choose to view key fields like UserId, Channel, etc. or any custom fields added against the sessions.
  • Date Range is provided by default, you can set the values for preview puposes. This is set by default to past 7 days and can be customized to a range of 90 days upto 365 days in the past.
  • Select fields to be depicted by the Widget.
    • Depending upon the Dataset selected the Fields will vary. See the table below for detailed listing.
    • You can apply on these fields the aggregation functions like “min”, “max”, “sum”, “count”, or “avg”“.
    • Apart from these if you have defined any Custom/Meta Tags for your Bot, you can use them under the appropriate heading using the following notation: userTag.tagname = value. That is, if you have declared a Message level custom tag, select the Message Dataset and enter messageTag.TagName.
  • Filter By fields can be used to define the criteria for filtering results. You can apply the following operators on these fields: “=”, “>=”, “<=”, “>”, “<“.
  • Group By fields for applying the aggregating functions.
  • Sort By fields to order the results in ascending or descending order – “asc”, or “desc”.

Run the query to see the results in a tabular format.

Data Representation

The next step would be to render the data in a visually appealing way. The following options are available for data representation:

  • Table will render the data in a simple row and column format. You can specify the Columns and their order from the Dimensions option.
  • Bar Chart can be used to depict the data across the X- and Y-axis
  • Line Chart can be used to depict the data across the X- and Y-axis. The results can be split into Data Series based on the Overlay field and get multiple lines plotted.
  • Pie Chart can be used for aggregation data to depict part-of-whole scenarios. Use Dimensions to set the fields to be depicted and the Metrics to set the aggregation function to be depicted.

Use the Preview button to visualize the Widget. If it suits your purpose, add the widget to your to Dashboard to save the changes.
NOTE: You have to Run the query to be able to Preview it.

Widget Actions

Using the more icon (vertical ellipses) against each Widget, you can:

  • Edit option will open the Widget definition page where you can make changes to an already defined Widget.
  • Clone option can be used to duplicate the Widget definition and modify it.
  • Export option can be used to export widget data in JSON format.
  • Delete option can be used to delete the widget from the Dashboard.

Limitations

  • You can define a maximum of 100 custom dashboards.
  • Each dashboard can include a maximum of 100 widgets.
  • A maximum of 3 metrics can be added to chart.
  • Each chart can render 1 dimension.
  • The custom date range can be set to a range of 90 days upto 365 days in the past.

Dataset & Fields

Note that the field names are case sensitive and should be used as indicated in the tables below.

Analytics

Source Field Field Name Data Type Possible Value
result metricType Text
  • success
  • successintent
  • failtask
  • failintent
Task Name taskName Text Name of the Task being executed
input userInput Text User Utterance triggering the above Task
isBB isDeveloper Text
  • 0
  • 1
failureDetails failureDetails Text
language language Text
  • en (for English)
  • de (for German)
  • es (for Spanish)
  • fr (for French)
  • pt (for Portuguese (Brazilian))
  • it (for Italian)
  • zh_cn (for Chinese Simplified)
  • zh_tw (for Chinese Traditional)
  • id (for Indonesian)
  • ko (for Korean)
  • nl (for Dutch)
  • ja (for Japanese)
  • ar (for Arabic)
  • fi (for Finnish)
  • ru (for Russian)
  • pl (for Polish)
  • uk (for Ukrainian)
  • sv (for Swedish)
channel channel Text
  • skypeforbusiness (for Skype for Business)
  • msteams (for Microsoft Teams)
  • twitter (for Twitter)
  • spark (for Cisco Spark)
  • rtm (for Web/Mobile Client)
  • Facebook (for Facebook Messenger)
  • slack (for Slack)
  • skype (for Skype)
  • kore (for Kore Messenger)
  • email (for Email)
  • sms (for SMS)
  • wfacebook (for Workplace by Facebook)
  • ringcentral (for RingCentral Glip)
  • jabber (for Cisco Jabber)
  • yammer (for Microsoft Yammer)
  • alexa (for Amazon Alexa)
  • twiliovoice (for Twilio Voice)
  • telegram (for Telegram)
  • ivr (for Webhook)
  • ivrVoice (for IVR)
  • line (for Line Messenger)
  • liveperson (for Liveperson)
  • googleactions (for Google Assistant)
  • wechat (for WeChat)
  • hangoutchat (for Hangout Chat)
  • mattermost (for Mattermost)
sessionId sessionId Text of the form:

5d8361063b790ae15727d75f

trained trainingStatus Text
pinned pinStatus Text
  • true, or
  • false
isAmbiguous matchType Text
  • true, or
  • false
userId userId Text email id or enterprise assigned user id

Messages

Source Field Field Name Data Type Possible Value
type messageType string
  • incoming
  • outgoing
  • event
isBB isDeveloper number
  • 0
  • 1
message Id messageId (not allowed as dimension in widget representation) string of the form:

ms-35bb7391-edc9-5a7a-859c-5682f787a684

channel channel string
  • skypeforbusiness (for Skype for Business)
  • msteams (for Microsoft Teams)
  • twitter (for Twitter)
  • spark (for Cisco Spark)
  • rtm (for Web/Mobile Client)
  • Facebook (for Facebook Messenger)
  • slack (for Slack)
  • skype (for Skype)
  • kore (for Kore Messenger)
  • email (for Email)
  • sms (for SMS)
  • wfacebook (for Workplace by Facebook)
  • ringcentral (for RingCentral Glip)
  • jabber (for Cisco Jabber)
  • yammer (for Microsoft Yammer)
  • alexa (for Amazon Alexa)
  • twiliovoice (for Twilio Voice)
  • telegram (for Telegram)
  • ivr (for Webhook)
  • ivrVoice (for IVR)
  • line (for Line Messenger)
  • liveperson (for Liveperson)
  • googleactions (for Google Assistant)
  • wechat (for WeChat)
  • hangoutchat (for Hangout Chat)
  • mattermost (for Mattermost)
sessionId sessionId string of the form:

5daecb96e79dbaabb87fd4c4

userId userId Text email id or enterprise assigned user id
languages used in this message language Text
  • en (for English)
  • de (for German)
  • es (for Spanish)
  • fr (for French)
  • pt (for Portuguese (Brazilian))
  • it (for Italian)
  • zh_cn (for Chinese Simplified)
  • zh_tw (for Chinese Traditional)
  • id (for Indonesian)
  • ko (for Korean)
  • nl (for Dutch)
  • ja (for Japanese)
  • ar (for Arabic)
  • fi (for Finnish)
  • ru (for Russian)
  • pl (for Polish)
  • uk (for Ukrainian)
  • sv (for Swedish)

Sessions

Source Field Field Name Data Type Possible Value
uId username string User Name
channel channel string
  • skypeforbusiness (for Skype for Business)
  • msteams (for Microsoft Teams)
  • twitter (for Twitter)
  • spark (for Cisco Spark)
  • rtm (for Web/Mobile Client)
  • Facebook (for Facebook Messenger)
  • slack (for Slack)
  • skype (for Skype)
  • kore (for Kore Messenger)
  • email (for Email)
  • sms (for SMS)
  • wfacebook (for Workplace by Facebook)
  • ringcentral (for RingCentral Glip)
  • jabber (for Cisco Jabber)
  • yammer (for Microsoft Yammer)
  • alexa (for Amazon Alexa)
  • twiliovoice (for Twilio Voice)
  • telegram (for Telegram)
  • ivr (for Webhook)
  • ivrVoice (for IVR)
  • line (for Line Messenger)
  • liveperson (for Liveperson)
  • googleactions (for Google Assistant)
  • wechat (for WeChat)
  • hangoutchat (for Hangout Chat)
  • mattermost (for Mattermost)
languages during that session language Text
  • en (for English)
  • de (for German)
  • es (for Spanish)
  • fr (for French)
  • pt (for Portuguese (Brazilian))
  • it (for Italian)
  • zh_cn (for Chinese Simplified)
  • zh_tw (for Chinese Traditional)
  • id (for Indonesian)
  • ko (for Korean)
  • nl (for Dutch)
  • ja (for Japanese)
  • ar (for Arabic)
  • fi (for Finnish)
  • ru (for Russian)
  • pl (for Polish)
  • uk (for Ukrainian)
  • sv (for Swedish)
session start time date Date mm-dd-yyyy
Menu