OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

カスタム ダッシュボード

カスタムダッシュボードでは、組み込みのメトリクスや、ユーザーの属性またはコンテクストの情報に基づいたカスタムKPIを組み合わせて、ビジネスニーズに応じた独自のレポートやダッシュボードを設計することができます。

カスタムダッシュボードは、搭載されているダッシュボードのレポートに加えてボットビルダーで利用することができます。デフォルトダッシュボードについては、こちらをご覧ください。

カスタムダッシュボードは、次の簡単な手順で構築できます。

  1. メトリクスを得るために必要なデータポイントを特定します。これは、お客様のビジネス要件とニーズに基づいています。
  2. これらのデータポイントをボット定義で発信するために、適切なカスタムメタタグを定義します。ボットにカスタムメタタグを追加する方法については、こちらをご覧ください
  3. ウィジェットを設計、プレビューし、ウィジェットでダッシュボードを更新します。このドキュメントの残りの部分では、以下の手順を説明しています。

なお、バージョン8.0のプラットフォームでは、会話セッションには、ユーザーからのメッセージがない非対話型のセッションも含まれています。この変更に伴い、同リリース以降、セッション数が増加する可能性があります。

左ナビゲーションメニューのダッシュボードにあるカスタムダッシュボードを利用すると、ボット用に複数のカスタムダッシュボードを追加できます。

  • ダッシュボードには、1つ以上のウィジェットを設定できます。
  • それぞれのウィジェットは、事前に定義されたデータセットに関連付けることができます。
  • データセットは、ウィジェットに表示する必要なデータを抽出するためのクエリ (SQLに似たもの) を定義するために使用できます。
  • データの生成には、メッセージ、セッション、アナリティクス、およびメタタグに関する情報を使用できます。

ここでは、上記の各コンポーネントを使用してカスタム ダッシュボードを構築する方法を説明します。

ダッシュボード

ダッシュボードの基本情報を入力すると、1つ以上のダッシュボードを追加できます。

  • ダッシュボードの名前はいつでも編集・変更することができます。
  • すべてのダッシュボードには、24時間7日間、またはカスタム範囲に設定できるフィルターである日付範囲が付属しており、これはダッシュボードのすべてのウィジェットに適用されます。
  • ダッシュボードのカラーテーマを選択することができます。
  • ダッシュボードにウィジェットを追加することができます (詳しくはこちらをご覧ください)。
  • ウィジェットの上にマウスを置くと表示される移動カーソルを使って、ダッシュボード上の任意の場所にウィジェットをドラッグして並べ替えることができます。
  • [その他] (垂直の省略記号) アイコンを使用して、ダッシュボードの新規作成ダッシュボードの複製ダッシュボードのエクスポートダッシュボードの削除のいずれかを行うことができます。
  • ダッシュボードのデータは、JSON形式でエクスポートできます。

ウィジェット

ダッシュボードには、1つ以上のウィジェットを追加できます。ダッシュボードにウィジェットを追加するには、ウィジェット追加オプションを使用します。ウィジェットの設定には 2つの手順があります。

  1. データの定義
  2. データの表示

データの定義

すべてのウィジェットは、どのような情報を取得してウィジェット上で表示するかを指定するクエリ定義と関連付けられている必要があります。以下は、クエリ定義を生成するための設定です。

  • データのソースを定義するデータセットです。以下のようになります。
    • 分析:分析で、ボットの成功インテント、失敗インテント、成功タスク、失敗タスクに関するデータにアクセスできます。MetrixType、Channel、UserIdなどの キーフィールドや、メトリクスレコードに追加されたカスタムフィールドを選んで表示することができます。
    • メッセージ: このデータセットは、ボットのボットメッセージとユーザーメッセージを提供します。UserId、チャネルなどの キーフィールドや、メッセージに対して追加されたカスタムフィールドの表示を選択できます。
    • セッション: このデータセットを使用して、ボットに関連する会話セッションのリストを提供します。UserIdやChannelなどの キーフィールドや、セッションに追加されたカスタムフィールドを選んで表示することができます。
  • 日付範囲はデフォルトで提供されていますが、プレビュー用に値を設定することができます。デフォルトでは過去7日間に設定されていますが、90日から365日までの範囲でカスタマイズできます。
  • ウィジェットで表示するフィールドを選択します。
    • 選択したデータセットに応じて、フィールドが異なります。詳細なリストについては、こちらをご覧ください。たとえば、成功・失敗インテントをリストアップするには、metricTypeを使用します。
    • これらのフィールドには、「min」、「max」、「sum」、「count」、「avg」などの集計関数を適用することができます。
      たとえば、トリガーされたインテントの合計を数えるには、count(metricType)を使用します。
    • 表示名をエイリアスとして設定することができます。たとえば、count(metricType)をtotalとします
    • これらとは別に、ボットにカスタム/メタタグを定義している場合は、以下の記述で適切な見出しの下にそれらを使用することができます。
      userTag.tagname = value。メッセージレベルのカスタムタグを宣言している場合は、メッセージデータセットを選択し、messageTag.TagNameを入力します。バージョン8.1以降では、まだ定義されていないカスタムタグを使用することもできますが、この場合はデータセットが空になり、その結果、表示もされなくなることに注意してください。
  • 絞り込みフィールド (選択した句のエイリアスではなく、実際のフィールド名) は、結果をフィルタリングするための基準を定義するのに使用します。これらのフィールドには、以下の演算子を適用できます。「=」、「>=」、「<=」、「>」、「<」、「in」, 「not in」。たとえば、成功したダイアログの両方のインテントとタスクをリストアップするには、metricType = successintentsまたはmetricType = successtasks、tasktype = dialogとします。複数の条件を結合している間は、左から右へと判断され、この順序は括弧 () を使用して変更できないことに注意してください。
  • グループ化フィールド (選択した句のエイリアスではなく、実際のフィールド名) は、集約関数を適用するのに使用します。たとえば上記の例では、メトリクスタイプであるmetricTypeに基づいて集計を行います。
  • 結果を昇順または降順に並べる並べ替えフィールドには、(選択した句のエイリアスではなく、実際のフィールド名) は、「asc」または 「desc」を使用します。たとえば、メトリクスタイプの降順で整理するには、metricType descとします。

このクエリを実行すると、結果が表形式で表示されます。

データの表示

次の手順では、データを視覚的に魅力的な方法で表示します。データ表示には以下のオプションがあります。

  • テーブルは、シンプルな行と列の形式でデータを表示します。表は、シンプルな行と列の形式でデータを表示します。列とその順序は、ディメンションオプションで指定できます。
  • ピボット・チャートは、データの要約に役立ちますディメンション – 表示する列、メトリクス – 列に対する値、オーバーレイ – データシリーズの表示が必要な場合に考慮される列を指定できます。たとえば、ディメンションを「日付」、メトリクスを「チャット数」、オーバーレイを「顧客タイプ」と設定した場合、顧客タイプごとのチャット数が表示されます。
  • 棒グラフは、X軸Y軸でデータを描写するのに使用されます。結果は、オーバーレイフィールドに基づいてデータシリーズに分割され、複数のラインがプロットされます。
  • 横棒グラフは棒グラフを反転させたもので、X軸Y軸でデータを描写します。結果は、オーバーレイフィールドに基づいてデータシリーズに分割され、複数のラインがプロットされます。
  • 折れ線グラフは、X軸Y軸でデータを描写するのに使用されます。結果は、オーバーレイフィールドに基づいてデータシリーズに分割され、複数のラインがプロットされます。
  • 円グラフは、全体の中の一部を表示するための集計データに使用できます。ディメンションで表示するフィールドを設定し、メトリクスで表示する集計機能を設定します。
  • ドーナツグラフは、円グラフと同様に、より見やすくするために使用できます。
  • ラベルグラフは、値やメトリクスを独自のスペースで強調するのに使用できます。

プレビューボタンを使用して、ウィジェットを確認します。目的に合っていれば、ウィジェットをダッシュボードに追加して変更を保存します。
注意:プレビューするには、クエリを実行する必要があります。

ウィジェットの操作

各ウィジェットの詳細アイコン (垂直の省略記号) を使用して、以下のようなことができます。

  • 編集オプションは、既に定義されたウィジェットに変更を加えることができるウィジェット定義ページを開きます。
  • 複製オプションは、ウィジェットの定義を複製し、変更を加えるのに使用されます。
  • エクスポートオプションは、ウィジェットのデータをJSON形式でエクスポートするために使用します。
  • 削除オプションは、ダッシュボードからウィジェットを削除するのに使用します。

制限事項

  • カスタム ダッシュボードは、最大100個まで定義できます。
  • 各ダッシュボードには、最大100個のウィジェットを含めることができます。
  • チャートに追加できるメトリクスは最大3つです。
  • 各チャートは 1つのディメンションをレンダリングできます。
  • カスタムの日付範囲は、90日から365日までの過去の範囲に設定できます。

データセットとフィールド

フィールド名は大文字と小文字を区別し、以下の表のように使用してください。

分析

フィールド名 データタイプ 可能な値
metricType テキスト
  • successtasks
  • successintents
  • failedtasks
  • failedintents
taskName テキスト 実行中のタスク名
taskType テキスト
  • ダイアログ
  • アクション (情報タスクも含む)
  • 通知
  • よくあるご質問
  • スモールトーク
isDeveloper テキスト
  • 除外
  • 含む
failurereason テキスト
failurepoint テキスト
言語 テキスト
  • en (英語用)
  • de (ドイツ語用)
  • es (スペイン語用)
  • fr (フランス語用)
  • pt (ポルトガル語 (ブラジル) 用)
  • it (イタリア語用)
  • zh_cn (中国語簡体字用)
  • zh_tw (中国語繁体字用)
  • id (インドネシア語用)
  • ko (韓国語用)
  • nl (オランダ語用)
  • ja (日本語用)
  • ar (アラビア語用)
  • fi (フィンランド語用)
  • ru (ロシア語用)
  • pl (ポーランド語用)
  • uk (ウクライナ語用)
  • sv (スウェーデン語用)
チャネル テキスト
  • skypeforbusiness (Skype for Business用)
  • msteams (Microsoft Teams用)
  • twitter (Twitter用)
  • spark (Cisco Spark用)
  • rtm (Web/Mobile Client用)
  • Facebook (Facebook Messenger用)
  • slack (Slack用)
  • skype (Skype用)
  • kore (Kore Messenger用)
  • email (Email用)
  • sms (SMS用)
  • wfacebook (Workplace by Facebook用)
  • ringcentral (RingCentral Glip用)
  • jabber (Cisco Jabber用)
  • yammer (Microsoft Yammer用)
  • alexa (Amazon Alexa用)
  • twiliovoice (Twilio Voice用)
  • telegram (Telegram用)
  • ivr (Webhook用)
  • ivrVoice (IVR用)
  • line (LINE Messenger用)
  • liveperson (Liveperson 用)
  • googleactions (Google Assistant用)
  • wechat (WeChat用)
  • hangoutchat (Hangout Chat用)
  • mattermost (Mattermost用)
sessionId (ウィジェット表示ではディメンションとして認められません) テキスト 形式は:

5d8361063b790ae15727d75f

trainingStatus テキスト
  • true、または
  • false
pinStatus テキスト
  • true、または
  • false
matchType テキスト
  • true、または
  • false
userId テキスト メールIDまたはエンタープライズにより割り当てたられたユーザーID
’channeluserid (ウィジェット表示ではディメンションとして認められません) テキスト
timestampvalue 番号
日付 日付

メッセージ

フィールド名 データタイプ 可能な値
メッセージタイプ 文字列
  • 受信 – ユーザーメッセージ用
  • 送信 – ボット応答用
isDeveloper 番号
  • 除外
  • 含む
messageId (ウィジェット表示ではディメンションとして認められません) 文字列 形式は:

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

チャネル 文字列
  • skypeforbusiness (Skype for Business用)
  • msteams (Microsoft Teams用)
  • twitter (Twitter用)
  • spark (Cisco Spark用)
  • rtm (Web/Mobile Client用)
  • Facebook (Facebook Messenger用)
  • slack (Slack用)
  • skype (Skype用)
  • kore (Kore Messenger用)
  • email (Email用)
  • sms (SMS用)
  • wfacebook (Workplace by Facebook用)
  • ringcentral (RingCentral Glip用)
  • jabber (Cisco Jabber用)
  • yammer (Microsoft Yammer用)
  • alexa (Amazon Alexa用)
  • twiliovoice (Twilio Voice用)
  • telegram (Telegram用)
  • ivr (Webhook用)
  • ivrVoice (IVR用)
  • line (LINE Messenger用)
  • liveperson (Liveperson 用)
  • googleactions (Google Assistant用)
  • wechat (WeChat用)
  • hangoutchat (Hangout Chat用)
  • mattermost (Mattermost用)
sessionId (ウィジェット表示ではディメンションとして認められません) 文字列 形式は:

5daecb96e79dbaabb87fd4c4

言語 テキスト
  • en (英語用)
  • de (ドイツ語用)
  • es (スペイン語用)
  • fr (フランス語用)
  • pt (ポルトガル語 (ブラジル) 用)
  • it (イタリア語用)
  • zh_cn (中国語簡体字用)
  • zh_tw (中国語繁体字用)
  • id (インドネシア語用)
  • ko (韓国語用)
  • nl (オランダ語用)
  • ja (日本語用)
  • ar (アラビア語用)
  • fi (フィンランド語用)
  • ru (ロシア語用)
  • pl (ポーランド語用)
  • uk (ウクライナ語用)
  • sv (スウェーデン語用)
userId テキスト メールIDまたはエンタープライズにより割り当てたられたユーザーID
timestampvalue 番号 メッセージのタイムスタンプ
date 日付 メッセージの作成日
username 文字列 ユーザー名

セッション

フィールド名 データタイプ 可能な値
streamid (ウィジェット表示ではディメンションとして認められません) 文字列 ボット ID
sessionid 文字列 形式は:

5daecb96e79dbaabb87fd4c4

userId 文字列 メールIDまたはエンタープライズにより割り当てられたユーザーID
username 文字列 ユーザー名
sessiontype 文字列 会話のセッションタイプ

  • 対話型;
  • 非対話型
チャネル 文字列
  • skypeforbusiness (Skype for Business用)
  • msteams (Microsoft Teams用)
  • twitter (Twitter用)
  • spark (Cisco Spark用)
  • rtm (Web/Mobile Client用)
  • Facebook (Facebook Messenger用)
  • slack (Slack用)
  • skype (Skype用)
  • kore (Kore Messenger用)
  • email (Email用)
  • sms (SMS用)
  • wfacebook (Workplace by Facebook用)
  • ringcentral (RingCentral Glip用)
  • jabber (Cisco Jabber用)
  • yammer (Microsoft Yammer用)
  • alexa (Amazon Alexa用)
  • twiliovoice (Twilio Voice用)
  • telegram (Telegram用)
  • ivr (Webhook用)
  • ivrVoice (IVR用)
  • line (LINE Messenger用)
  • liveperson (Liveperson 用)
  • googleactions (Google Assistant用)
  • wechat (WeChat用)
  • hangoutchat (Hangout Chat用)
  • mattermost (Mattermost用)
言語 テキスト
  • en (英語用)
  • de (ドイツ語用)
  • es (スペイン語用)
  • fr (フランス語用)
  • pt (ポルトガル語 (ブラジル) 用)
  • it (イタリア語用)
  • zh_cn (中国語簡体字用)
  • zh_tw (中国語繁体字用)
  • id (インドネシア語用)
  • ko (韓国語用)
  • nl (オランダ語用)
  • ja (日本語用)
  • ar (アラビア語用)
  • fi (フィンランド語用)
  • ru (ロシア語用)
  • pl (ポーランド語用)
  • uk (ウクライナ語用)
  • sv (スウェーデン語用)
タイムスタンプの値 番号 タイムスタンプ値
date 日付 mm-dd-yyyy
OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Create a Simple Bot
SKILLS
Storyboard
Dialog Tasks
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Train
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Introduction
How to Configure Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Bot Versioning
Collaborative Development
Plan Management
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Create a Simple Bot
Create a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
RELEASE NOTES

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.

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.

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

You can use the Custom Dashboards under Analyze tab from the top 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 pre-defined 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.

  • 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.

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
  2. Data Representation

Data Definition

Every widget should be associated 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 purposes. 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.
    • Depending upon the Dataset selected the Fields will vary. See the table below for detailed listing. 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 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. 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 ()
  • 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
  • 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 & Fields

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

Analytics

Field Name Data Type Possible Value
metricType Text
  • successtasks
  • successintents
  • failedtasks
  • failedintents
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
  • 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 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 (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 bot 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
  • 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 (not allowed as a dimension in widget representation) string of the form:

5daecb96e79dbaabb87fd4c4

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)
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
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
  • 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)
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)
timestampvalue Number Timestamp value
date Date mm-dd-yyyy