GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
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
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
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
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
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Docs
  2. Virtual Assistants
  3. API Guide
  4. Task Execution-Based Containment Report API

Task Execution-Based Containment Report API

This task-wise Containment Report offers a comparative analysis of the impact of task executions on overall containment. It breaks down task-wise successes and failures by containment type, including Drop-off, Self-service, and Agent Hand-off, providing a detailed overview for better understanding and decision-making.

Method POST and GET
Endpoint It’s a combination of POST and GET methods. The POST method is used to set the filters and the GET method is used to fetch data as per the set filters.

Post Method: Set filters. The response contains the API Response ID (“_id”)
https://{{host}}/api/public/bot/{{botID}}/taskContainmentReport?skip={{skipValue}}&limit={{limitValue}}

Get Method: Use the API Response ID (“_id”) to get data as per the set filters.  
https://{{host}}/api/public/bot/{{botID}}/taskContainmentReport/status/{{_id}}

Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Metrics
  • Admin Console: Not Applicable

Path Parameters

Parameter Required/Optional Description
host Required Environment URL. For example, https://bots.kore.ai
BotID Required Bot ID or Stream ID can be accessed from the General Settings page of the virtual assistant.
_id Required (only for GET) The API Response ID returned by the POST method in the response object; Use it in the GET method to get data as per the set filters via the POST method.
skip Optional (only for POST) The number of messages to be skipped
limit Optional (only for POST) The number of messages to be shown on each page.

Sample Request for the POST Method

The following sample request shows how to retrieve task-execution based analytics data for different containment types with specific filters. You can modify the type and filters parameters to retrieve different types of analytics data as needed.

curl --location 'https://{{host}}/api/public/bot/{{botId}}/taskContainmentReport?skip={{skipValue}}&limit={{limitValue}}' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
    "filters": {
        "dateFrom": "2024-04-22",
        "dateTo": "2024-04-30T00:00:00.000Z",
        "ConversationStatus": "Active",
        "ConversationType": "Interactive",
        "AggregationType": "Daily"
    }
}'

Request Body Parameters

Parameter Required/Optional Description
dateFrom Optional
  • The start time selected for the report generation.
  • If not provided, the system considers 7 days prior to the dateTo value.
  • The following formats are accepted:
    • >yyyy-mm-dd
    • >yyyy-mm-ddThh:mm:ss.msZ
dateTo Optional
  • The end time selected for the report generation.
  • If not provided,  the system considers 7 days after the dateFrom value. If dateFrom is also not provided then it is set to Today  and the timeframe considered is the previous 7 days from Today.
  • The following formats are accepted:
    • >yyyy-mm-dd
    • >yyyy-mm-ddThh:mm:ss.msZ
  • The maximum or allowed time range selection is 90 days.
includeTaskName Optional An array of strings representing task names for which the execution report is generated. 
ConversationType Optional The following conversation types for which data is available:

  • Interactive
  • Non-Interactive
ConversationStatus Optional The current conversation status, Active, or Closed.
AggregationType Optional One of the following report aggregation types:

  • Daily: Generates daily reports. The allowed/maximum data range selection is 30 days.
  • Cumulative: Generates weekly, monthly, or custom date range reports.
tags Optional Emitted custom tags represented as an array of objects to filter the task execution data.

Sample Response for the Post Method

The response returns the API Response ID _id (as highlighted in the sample payload below). Please use this value as a query parameter in the GET request.

{
   "status": "IN_PROGRESS",
   "percentageComplete": 0,
   "streamId": "st-9xxxxxx9-0xx9-5xxd-8xxa-7xxxxxxxxx56",
   "jobType": "TASK_EXECUTION_CONTAINMENT_REPORT",
   "action": "QUERY",
   "countOfDockStatuses": 1,
   "createdBy": "u-exxxxxx6-6xx1-5xx5-axx4-5xxxxxxxxxd2",
   "expireAt": "2024-03-08T12:30:46.247Z",
   "statusLogs": [],
   "_id": "ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083",
   "lMod": "2024-03-08T12:15:46.000Z",
   "createdOn": "2024-03-08T12:15:46.253Z",
   "requestedTime": "2024-03-08T12:15:46.253Z",
   "__v": 0
}

Response Body Parameters

Parameter Description
status Status of the task execution. Successful execution of a task is marked as ‘Success‘. Any failure in executing the task, including drop-off, is marked as a ‘Failure.’
percentageComplete The percentage of task execution completed.
streamId Can be accessed from the General Settings page of the Virtual Assistant.
jobType Task Execution Containment Report.
action Query action for task execution.
countOfDockStatuses The number of dock statuses generated for the task execution-based report.
createdBy The user ID of the end user who created the task execution-based report for a virtual assistant.
expireAt Task execution expiry timestamp.
statusLogs An array of status logs for the task execution.
_id The API Response ID.
lMod The last modified time for the task execution-based report.
createdOn The task execution-based report creation date.
requestedTime The time of request for the task execution-based report.
__v The field is used for internal purposes. No specific significance.

Sample Request for the GET Method

The _id  generated by the POST method, (for example, considerds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083 shown in the sample POST response) should be used as the query parameter in the GET Method.

curl --location
'https://prod-bots.korebots.com/api/public/bot/st-8xxxxxxc-cxx2-5xxf-axx5-9xxxxxxxxxxb/taskContainmentReport/status/ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'

Sample Response for the GET Method

{
   "tasksExecutionReport": {
   "total": 8,
   "data": {
   "2024-03-07": [
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Tags 1",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
      },
      {
         "totalExecution": 2,
         "totalSession": 2,
         "selfServiceSessions": 0,
         "dropOffSessions": 0,
         "agentTransferSessions": 2,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Agent Transfer",
         "Status": "success",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 100
       },
       {
         "totalExecution": 12,
         "totalSession": 6,
         "selfServiceSessions": 2,
         "dropOffSessions": 2,
         "agentTransferSessions": 2,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Age Predictor",
         "Status": "success",
         "selfServiceSessionsInPercentage": "33.33",
         "dropOffSessionsInPercentage": "33.33",
         "agentTransferSessionsInPercentage": "33.33"
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Tags 2",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Phone Number Verification",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 0,
         "dropOffSessions": 1,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Create Booking",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 100,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 2,
         "totalSession": 2,
         "selfServiceSessions": 0,
         "dropOffSessions": 2,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Age Predictor",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 100,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Currency",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
        }
      ]
    }
  },
  "status": "SUCCESS"
}

Response Body Parameters

Parameter Description
totalExecution The overall count of the successful or failed tasks executed for a conversation session.
totalSession Total number of conversation sessions during which the specified task is executed.  

If a task is executed more than once within a single conversation session and yields different results, the session will be counted twice. For instance, if Task 1 is performed twice in the same conversation session, with one execution being successful and the other failing, this session will be counted under both the Success and Failure categories for Task 1.

selfServiceSessions Total number of conversation sessions that are marked as Self-service during which the specified task is executed (Success or Failure).

Self-service sessions refer to the conversations that the virtual assistant contains.

dropOffSessions Total number of conversation sessions that are marked as Drop-off during which the specified task is executed (Success or Failure).

A session is classified as Drop-off when the user abandons the conversation in one of the following scenarios:

  • Leaves the conversation abruptly without completing the task.
  • Leaves the conversation after the task resulted in a failure.
  • The last utterance of the user does not detect any intent.
  • The virtual assistant stops responding due to any reason.
agentTransferSessions The total number of conversation sessions marked as Agent Transfer during which the specified task is executed (Success or Failure).

A session is classified as an Agent Transfer if the conversation leads to an agent transfer in a session.

dateRange The date range based on the selected dateFrom” and “dateTo” values.
taskType The type of task executed for a conversation session. The task executed can be a Dialog, Alert task, FAQ.
taskName Name of the task executed, including Dialog Tasks, Alert Tasks, and FAQs.
Status Tasks that are successfully executed are marked as ‘Success’. Unsuccessful tasks, including drop-off, are marked as ‘Failure’.
selfServiceSessionsInPercentage The percentage of sessions that are classified as Self-Service out of the total number of sessions that are displayed for a task status.
dropOffSessionsInPercentage The percentage of sessions that are classified as drop-off out of the total number of sessions that are displayed for a task status.
agentTransferSessionsInPercentage The percentage of sessions that are classified as Agent Hand-off or transfer out of the total number of sessions that are displayed for a task status.

Task Execution-Based Containment Report API

This task-wise Containment Report offers a comparative analysis of the impact of task executions on overall containment. It breaks down task-wise successes and failures by containment type, including Drop-off, Self-service, and Agent Hand-off, providing a detailed overview for better understanding and decision-making.

Method POST and GET
Endpoint It’s a combination of POST and GET methods. The POST method is used to set the filters and the GET method is used to fetch data as per the set filters.

Post Method: Set filters. The response contains the API Response ID (“_id”)
https://{{host}}/api/public/bot/{{botID}}/taskContainmentReport?skip={{skipValue}}&limit={{limitValue}}

Get Method: Use the API Response ID (“_id”) to get data as per the set filters.  
https://{{host}}/api/public/bot/{{botID}}/taskContainmentReport/status/{{_id}}

Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Metrics
  • Admin Console: Not Applicable

Path Parameters

Parameter Required/Optional Description
host Required Environment URL. For example, https://bots.kore.ai
BotID Required Bot ID or Stream ID can be accessed from the General Settings page of the virtual assistant.
_id Required (only for GET) The API Response ID returned by the POST method in the response object; Use it in the GET method to get data as per the set filters via the POST method.
skip Optional (only for POST) The number of messages to be skipped
limit Optional (only for POST) The number of messages to be shown on each page.

Sample Request for the POST Method

The following sample request shows how to retrieve task-execution based analytics data for different containment types with specific filters. You can modify the type and filters parameters to retrieve different types of analytics data as needed.

curl --location 'https://{{host}}/api/public/bot/{{botId}}/taskContainmentReport?skip={{skipValue}}&limit={{limitValue}}' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
    "filters": {
        "dateFrom": "2024-04-22",
        "dateTo": "2024-04-30T00:00:00.000Z",
        "ConversationStatus": "Active",
        "ConversationType": "Interactive",
        "AggregationType": "Daily"
    }
}'

Request Body Parameters

Parameter Required/Optional Description
dateFrom Optional
  • The start time selected for the report generation.
  • If not provided, the system considers 7 days prior to the dateTo value.
  • The following formats are accepted:
    • >yyyy-mm-dd
    • >yyyy-mm-ddThh:mm:ss.msZ
dateTo Optional
  • The end time selected for the report generation.
  • If not provided,  the system considers 7 days after the dateFrom value. If dateFrom is also not provided then it is set to Today  and the timeframe considered is the previous 7 days from Today.
  • The following formats are accepted:
    • >yyyy-mm-dd
    • >yyyy-mm-ddThh:mm:ss.msZ
  • The maximum or allowed time range selection is 90 days.
includeTaskName Optional An array of strings representing task names for which the execution report is generated. 
ConversationType Optional The following conversation types for which data is available:

  • Interactive
  • Non-Interactive
ConversationStatus Optional The current conversation status, Active, or Closed.
AggregationType Optional One of the following report aggregation types:

  • Daily: Generates daily reports. The allowed/maximum data range selection is 30 days.
  • Cumulative: Generates weekly, monthly, or custom date range reports.
tags Optional Emitted custom tags represented as an array of objects to filter the task execution data.

Sample Response for the Post Method

The response returns the API Response ID _id (as highlighted in the sample payload below). Please use this value as a query parameter in the GET request.

{
   "status": "IN_PROGRESS",
   "percentageComplete": 0,
   "streamId": "st-9xxxxxx9-0xx9-5xxd-8xxa-7xxxxxxxxx56",
   "jobType": "TASK_EXECUTION_CONTAINMENT_REPORT",
   "action": "QUERY",
   "countOfDockStatuses": 1,
   "createdBy": "u-exxxxxx6-6xx1-5xx5-axx4-5xxxxxxxxxd2",
   "expireAt": "2024-03-08T12:30:46.247Z",
   "statusLogs": [],
   "_id": "ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083",
   "lMod": "2024-03-08T12:15:46.000Z",
   "createdOn": "2024-03-08T12:15:46.253Z",
   "requestedTime": "2024-03-08T12:15:46.253Z",
   "__v": 0
}

Response Body Parameters

Parameter Description
status Status of the task execution. Successful execution of a task is marked as ‘Success‘. Any failure in executing the task, including drop-off, is marked as a ‘Failure.’
percentageComplete The percentage of task execution completed.
streamId Can be accessed from the General Settings page of the Virtual Assistant.
jobType Task Execution Containment Report.
action Query action for task execution.
countOfDockStatuses The number of dock statuses generated for the task execution-based report.
createdBy The user ID of the end user who created the task execution-based report for a virtual assistant.
expireAt Task execution expiry timestamp.
statusLogs An array of status logs for the task execution.
_id The API Response ID.
lMod The last modified time for the task execution-based report.
createdOn The task execution-based report creation date.
requestedTime The time of request for the task execution-based report.
__v The field is used for internal purposes. No specific significance.

Sample Request for the GET Method

The _id  generated by the POST method, (for example, considerds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083 shown in the sample POST response) should be used as the query parameter in the GET Method.

curl --location
'https://prod-bots.korebots.com/api/public/bot/st-8xxxxxxc-cxx2-5xxf-axx5-9xxxxxxxxxxb/taskContainmentReport/status/ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'

Sample Response for the GET Method

{
   "tasksExecutionReport": {
   "total": 8,
   "data": {
   "2024-03-07": [
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Tags 1",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
      },
      {
         "totalExecution": 2,
         "totalSession": 2,
         "selfServiceSessions": 0,
         "dropOffSessions": 0,
         "agentTransferSessions": 2,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Agent Transfer",
         "Status": "success",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 100
       },
       {
         "totalExecution": 12,
         "totalSession": 6,
         "selfServiceSessions": 2,
         "dropOffSessions": 2,
         "agentTransferSessions": 2,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Age Predictor",
         "Status": "success",
         "selfServiceSessionsInPercentage": "33.33",
         "dropOffSessionsInPercentage": "33.33",
         "agentTransferSessionsInPercentage": "33.33"
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Tags 2",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Phone Number Verification",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 0,
         "dropOffSessions": 1,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Create Booking",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 100,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 2,
         "totalSession": 2,
         "selfServiceSessions": 0,
         "dropOffSessions": 2,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Age Predictor",
         "Status": "failtask",
         "selfServiceSessionsInPercentage": 0,
         "dropOffSessionsInPercentage": 100,
         "agentTransferSessionsInPercentage": 0
       },
       {
         "totalExecution": 1,
         "totalSession": 1,
         "selfServiceSessions": 1,
         "dropOffSessions": 0,
         "agentTransferSessions": 0,
         "dateRange": "2024-03-07",
         "taskType": "dialog",
         "taskName": "Currency",
         "Status": "success",
         "selfServiceSessionsInPercentage": 100,
         "dropOffSessionsInPercentage": 0,
         "agentTransferSessionsInPercentage": 0
        }
      ]
    }
  },
  "status": "SUCCESS"
}

Response Body Parameters

Parameter Description
totalExecution The overall count of the successful or failed tasks executed for a conversation session.
totalSession Total number of conversation sessions during which the specified task is executed.  

If a task is executed more than once within a single conversation session and yields different results, the session will be counted twice. For instance, if Task 1 is performed twice in the same conversation session, with one execution being successful and the other failing, this session will be counted under both the Success and Failure categories for Task 1.

selfServiceSessions Total number of conversation sessions that are marked as Self-service during which the specified task is executed (Success or Failure).

Self-service sessions refer to the conversations that the virtual assistant contains.

dropOffSessions Total number of conversation sessions that are marked as Drop-off during which the specified task is executed (Success or Failure).

A session is classified as Drop-off when the user abandons the conversation in one of the following scenarios:

  • Leaves the conversation abruptly without completing the task.
  • Leaves the conversation after the task resulted in a failure.
  • The last utterance of the user does not detect any intent.
  • The virtual assistant stops responding due to any reason.
agentTransferSessions The total number of conversation sessions marked as Agent Transfer during which the specified task is executed (Success or Failure).

A session is classified as an Agent Transfer if the conversation leads to an agent transfer in a session.

dateRange The date range based on the selected dateFrom” and “dateTo” values.
taskType The type of task executed for a conversation session. The task executed can be a Dialog, Alert task, FAQ.
taskName Name of the task executed, including Dialog Tasks, Alert Tasks, and FAQs.
Status Tasks that are successfully executed are marked as ‘Success’. Unsuccessful tasks, including drop-off, are marked as ‘Failure’.
selfServiceSessionsInPercentage The percentage of sessions that are classified as Self-Service out of the total number of sessions that are displayed for a task status.
dropOffSessionsInPercentage The percentage of sessions that are classified as drop-off out of the total number of sessions that are displayed for a task status.
agentTransferSessionsInPercentage The percentage of sessions that are classified as Agent Hand-off or transfer out of the total number of sessions that are displayed for a task status.
메뉴