GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Overview
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Introduction
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Configure Agent Transfer
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
APIs & SDKs
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Using the BotKit SDK
BotKit SDK Tutorial - Blue Prism
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Analyzing Your Bot
  5. Custom Dashboard

Custom Dashboard

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

Custom Dashboards are available along with the otherout-of-the-box dashboards in the Bot Builder. For more information on Default Dashboard, see here.

Follow these steps to build Custom Dashboards:

  1. Identify the data points that you need to capture for deriving the metrics, based on your business requirements and needs.
  2. Define suitable Custom Meta Tags to emit these data points in the Bot definition. To know how to add custom meta tags to your Virtual Assistant (VA), see here
  3. Design widgets, preview, and update the dashboard with these widgets.

The following sections describe the steps to create custom dashboard widgets.

Note: The conversation sessions include non-interactive sessions i.e. conversations with no messages from users.

Go to Analyze → Custom Dashboards in the left navigation menu, to add multiple custom dashboards for your VA.

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

Add Custom Dashboards

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

  • You can edit and modify the Dashboard Name anytime.
  • Every Dashboard comes with Date Range which is a filter that can be set to 24 Hrs, 7 Days, or custom range and this will be applicable for all widgets in the Dashboard.
  • You can choose a Color Theme for your 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.
  • Using the more (verticle ellipses) icon, you can either create a New DashboardClone DashboardExport Dashboard or Delete Dashboard.
  • Dashboard data can be exported in JSON format.

Add Widgets

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

  1. Data Definition
  2. Data Representation

Data Definition

Every widget must have a query defined, to retrieve and represent the required information on that Widget. Following are the configurations used to generate the query definition:

  • Dataset defines 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 VA. 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 VA and User messages for your VA. 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 VA. You can choose to view key fields like UserId, Channel, etc. or any custom fields added against the sessions.
  • Date Range This is set by default to the past 7 days and can be customized to a range of 90 days up to 365 days in the past.
  • Select fields to be depicted by the Widget.
    • The fields differ for each selected dataset. See the table for more details. For example to list the success & failed intents, metricType
    • You can apply on these fields the aggregation functions like “min”, “max”, “sum”, “count”, or “avg”“. For example to count the total triggered intents, count(metricType)
    • You can give a display name as an alias. For example, count(metricType) as total
    • Apart from these if you have defined any Custom/Meta Tags for your VA, 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. Post the release of v8.1, you can use custom tags that are not yet defined too, be aware that this would result in an empty dataset, and as such the display would be empty.
  • Filter By fields (actual field names, not alias as give in the Select clause) can be used to define the criteria for filtering results. You can apply the following operators on these fields: “=”, “>=”, “<=”, “>”, “<“, “in”, “not in”. For example to list the dialogs both intents and tasks which were successful, metricType = successintents or metricType = successtasks and tasktype = dialog. Note while conjugating multiple conditions they would be evaluated left to right, and this ordering cannot be changed using parentheses ()
  • Note: In the query setup, for Filter By, individual AND, OR operators, and multiple ANDs, ORs, can be applied, but a combination of AND/ORs, is not supported.

  • Group By fields (actual field names, not alias as give in the Select clause) for applying the aggregating functions. For example in the above example to total based on the metric type, metricType
  • Having clause is used to filter the results with aggregate functions as ‘Where’ keyword cannot be used here. For example, count(messageid)>10. The clause works only with the ‘Group By’ function.
    To understand how the Having clause works, see Filter the Messages using the Having Clause.
  • Sort By fields (actual field names, not alias as give in the Select clause) to order the results in ascending or descending order – “asc”, or “desc”. For example to sort in the descending order of the metric type, metricType 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.
  • Pivot chart will help summarise the data. You can specify the Dimensions – the columns to be displayed; Metrics – the value against the column; and Overlay – the column to be considered in case a data series needs to be represented. For example, if the dimension is set to be ‘date’, metric as ‘number of chats’ and overlay to be ‘customer type’ then the number of chats per customer type where each distinct customer type as series would be displayed.
  • Bar 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.
  • Horizontal Bar Chart can be used to depict the data across the X- and Y-axis, a flipped version of Bar Chart. The results can be split into Data Series based on the Overlay field and get multiple lines plotted.
  • 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.
  • Donut Chart can be used similar to a Pie chart for better visualization.
  • Label Chart can be used to highlight value or metric in a space of its own.

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
    • JSON format will include the final results that are displayed in the Widget UI
    • CSV format will export the results of the query that is associated with the widget (before converting the data as per the Widget UI)
  • 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 the chart.
  • Each chart can render 1 dimension.
  • The custom date range can be set to a range of 90 days up to 365 days in the past.

Dataset and Fields

The dataset fields and values are listed in the following table.

Note: The field names are case sensitive and should be used only as described here.

Analytics

Field Name Data Type Possible Value
metricType Text
  • successtasks
  • successintents
  • failedtasks
  • failedintents
  • unhandledutterances
eventtype string
  • “analyze”, “sentiment”, “tone”,
  • “entityretry”,
  • “confirmationretry”,
  • “onconnect”,
  • “endofconversation”,
  • “debuglog”,
  • “welcome”,
  • “telegramwelcomeevent”,
  • “facebookwelcomeevent”,
  • “telephonywelcomeeven”,
  • “standardresponseinterruption”,
  • “messagenodeinterruption”,
  • “optionalentity”,
  • “scriptfailure”,
  • “servicefailure”,
  • “agenttransfer”
nodename string Name of the node being created
nodetype string
  • confirmation
  • entity
taskName Text Name of the Task being executed
taskType Text
  • dialog
  • action (includes information task also)
  • alert
  • FAQ
  • smalltalk
isDeveloper Text
  • exclude
  • include
failurereason Text
failurepoint Text
language Text In the Kore.ai XO Platform over 100 languages are supported. For more information, see Supported Bot Languages.
channel Text A total of 37 channels are supported. For more information, see Channel Enablement-Available Channels.
sessionId (not allowed as dimension in widget representation) Text

of the form:

5d8361063b790ae15727d75f

trainingStatus Text
  • true, or
  • false
pinStatus Text
  • true, or
  • false
matchType Text
  • true, or
  • false
userId Text email id or enterprise assigned user id
channeluserid (not allowed as dimension in widget representation) Text
timestampvalue Number
date Date

Messages

Field Name Data Type Possible Value
messagetype string
  • incoming – for user messages
  • outgoing – for VA responses
isDeveloper number
  • exclude
  • include
messageId (not allowed as a dimension in widget representation) string

of the form:

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

channel string A total of 37 channels are supported. For more information, see Channel Enablement-Available Channels.
sessionId (not allowed as a dimension in widget representation) string

of the form:

5daecb96e79dbaabb87fd4c4

language Text In the Kore.ai XO Platform over 100 languages are supported. For more information, see Supported Bot Languages.
userId Text email id or enterprise assigned user id
timestampvalue Number the timestamp of the message
date Date Creation date on the message
username string user name

Sessions

Field Name Data Type Possible Value
isdeveloper string
  • include
  • exclude
sessionstatus string
  • active
  • closed
streamid (not allowed as a dimension in widget representation) string Bot id
sessionid string

of the form:

5daecb96e79dbaabb87fd4c4

userId string email id or enterprise assigned user id
username string User Name
sessiontype string

Conversation session type

  • Interactive;
  • Non-interactive
channel string A total of 37 channels are supported. For more information, see Channel Enablement-Available Channels.
language Text In the Kore.ai XO Platform over 100 languages are supported. For more information, see Supported Bot Languages.
timestampvalue Number Timestamp value
date Date mm-dd-yyyy
containment_type string
  • dropOff
  • selfService
  • agent
Menu