{"id":61448,"date":"2024-03-11T10:43:57","date_gmt":"2024-03-11T10:43:57","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=61448"},"modified":"2024-04-23T16:23:07","modified_gmt":"2024-04-23T15:23:07","slug":"task-execution-based-containment-report-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/task-execution-based-containment-report-api\/","title":{"rendered":"Task Execution-Based Containment Report API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

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.<\/span><\/p>\n\n\n\n\n\n\n\n
Method<\/strong><\/td>\nPOST and GET<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nIt\u2019s 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.<\/span><\/p>\n

Post Method<\/strong>: Set filters. The response contains the API Response ID (\u201c_id<\/em>\u201d)<\/span>
\nhttps:\/\/{{host}}\/api\/public\/bot\/{{botID}}\/taskContainmentReport<\/code><\/p>\n

Get Method<\/strong>: Use the API Response ID (\u201c_id<\/em>\u201d) to get data as per the set filters.\u00a0\u00a0<\/span>
\nhttps:\/\/{{host}}\/api\/public\/bot\/{{botID}}\/taskContainmentReport\/status\/{{<\/span>_id<\/b>}}<\/span><\/code><\/td>\n<\/tr>\n

Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: <\/span>Metrics<\/span><\/li>\n
  • Admin Console: Not Applicable<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    host<\/td>\nRequired<\/td>\nEnvironment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\n<\/tr>\n
    BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID can be accessed from the General Settings<\/strong> page of the virtual assistant.<\/td>\n<\/tr>\n
    _id<\/td>\nRequired (only for GET)<\/td>\nThe 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.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request for the POST Method<\/span><\/h2>\n

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

    curl --location 'https:\/\/prod-bots.korebots.com\/api\/public\/bot\/st-8xxxxxxc-cxx2-5xxf-axx5-9xxxxxxxxxxb\/taskContainmentReport' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n--header 'Content-Type: application\/json' \\\r\n--data '{\r\n    \"filters\": {\r\n        \"dateFrom\": \"2024-04-22\",\r\n        \"dateTo\": \"2024-04-30T00:00:00.000Z\",\r\n        \"ConversationStatus\": \"Active\",\r\n        \"ConversationType\": \"Interactive\",\r\n        \"AggregationType\": \"Daily\"\r\n    }\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Request Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    dateFrom<\/span><\/td>\nOptional<\/span><\/td>\n\n
      \n
    • The start time selected for the report generation.<\/li>\n
    • If not provided, the system considers 7 days prior to the<\/span> dateTo<\/i><\/b> value<\/span><\/i>.<\/span><\/li>\n
    • The following formats are accepted:<\/span>\n
        \n
      • >yyyy-mm-dd<\/code><\/li>\n
      •  >yyyy-mm-ddThh:mm:ss.msZ<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    dateTo<\/span><\/td>\nOptional<\/span><\/td>\n\n
      \n
    • The end time selected for the report generation.<\/span><\/li>\n
    • If not provided,\u00a0 the system considers 7 days after the <\/span>dateFrom <\/i><\/b>value. If<\/span> dateFrom<\/i><\/b> is also not provided then it is set to <\/span>Today<\/b> \u00a0and the timeframe considered is the previous 7 days from Today.<\/span><\/li>\n
    • The following formats are accepted:<\/span>\n
        \n
      • >yyyy-mm-dd<\/code><\/li>\n
      •  >yyyy-mm-ddThh:mm:ss.msZ<\/code><\/li>\n<\/ul>\n<\/li>\n
      • The maximum or allowed time range selection is 90 days.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    includeTaskName<\/span><\/td>\nOptional<\/span><\/td>\nAn array of strings representing task names for which the execution report is generated.\u00a0<\/span><\/span><\/td>\n<\/tr>\n
    ConversationType<\/span><\/td>\nOptional<\/span><\/td>\nThe following conversation types for which data is available:<\/span><\/p>\n
      \n
    • Interactive<\/li>\n
    • Non-Interactive<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    ConversationStatus<\/span><\/td>\nOptional<\/span><\/td>\nThe current conversation status, <\/span>Active<\/i><\/b>, or <\/span>Closed<\/i><\/b>.<\/i><\/td>\n<\/tr>\n
    AggregationType<\/span><\/td>\nOptional<\/span><\/td>\nOne of the following report aggregation types:<\/span><\/p>\n
      \n
    • Daily<\/span><\/i>: Generates daily reports. The allowed\/maximum data range selection is 30 days.<\/span><\/li>\n
    • Cumulative: <\/span><\/i>Generates weekly, monthly, or custom date range reports.<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    tags<\/span><\/td>\nOptional<\/span><\/td>\nEmitted custom tags represented as an array of objects to filter the task execution data. <\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response for the Post Method<\/span><\/h2>\n
    The response returns the API Response ID <\/span>“_id<\/i><\/strong>“<\/span> (as highlighted in the sample payload below). Please use this value as a query parameter in the GET request. <\/span><\/p>\n
    {\r\n   \"status\": \"IN_PROGRESS\",\r\n   \"percentageComplete\": 0,\r\n   \"streamId\": \"st-9xxxxxx9-0xx9-5xxd-8xxa-7xxxxxxxxx56\",\r\n   \"jobType\": \"TASK_EXECUTION_CONTAINMENT_REPORT\",\r\n   \"action\": \"QUERY\",\r\n   \"countOfDockStatuses\": 1,\r\n   \"createdBy\": \"u-exxxxxx6-6xx1-5xx5-axx4-5xxxxxxxxxd2\",\r\n   \"expireAt\": \"2024-03-08T12:30:46.247Z\",\r\n   \"statusLogs\": [],\r\n   \"_id\": \"ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083\"<\/b>,\r\n   \"lMod\": \"2024-03-08T12:15:46.000Z\",\r\n   \"createdOn\": \"2024-03-08T12:15:46.253Z\",\r\n   \"requestedTime\": \"2024-03-08T12:15:46.253Z\",\r\n   \"__v\": 0\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Response Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    status<\/span><\/td>\nStatus of the task execution. Successful execution of a task is marked as ‘Success<\/em>‘. Any failure in executing the task, including drop-off, is marked as a ‘Failure.’<\/em><\/span><\/td>\n<\/tr>\n
    percentageComplete<\/span><\/td>\nThe percentage of task execution completed.<\/span><\/td>\n<\/tr>\n
    streamId<\/span><\/td>\nCan be accessed from the General Settings page of the Virtual Assistant.<\/span><\/td>\n<\/tr>\n
    jobType<\/span><\/td>\nTask <\/span>Execution Containment Report.<\/span><\/td>\n<\/tr>\n
    action<\/span><\/td>\nQuery action for task execution.<\/span><\/td>\n<\/tr>\n
    countOfDockStatuses<\/span><\/td>\nThe number of dock statuses generated for the task execution-based report.<\/span><\/td>\n<\/tr>\n
    createdBy<\/span><\/td>\nThe user ID of the end user who created the task execution-based report for a virtual assistant.<\/span><\/td>\n<\/tr>\n
    expireAt<\/span><\/td>\nTask execution expiry timestamp.<\/span><\/td>\n<\/tr>\n
    statusLogs<\/span><\/td>\nAn array of status logs for the task execution.<\/span><\/td>\n<\/tr>\n
    _id<\/td>\nThe API Response ID.<\/span><\/td>\n<\/tr>\n
    lMod<\/span><\/td>\nThe last modified time for the task execution-based report.<\/span><\/td>\n<\/tr>\n
    createdOn<\/span><\/td>\nThe task execution-based report creation date.<\/span><\/td>\n<\/tr>\n
    requestedTime<\/span><\/td>\nThe time of request for the task execution-based report.<\/span><\/td>\n<\/tr>\n
    __v<\/span><\/td>\nThe field is used for internal purposes. No specific significance.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Request for the GET Method<\/span><\/h2>\n
    The _id\u00a0 <\/strong><\/em>generated by the POST method, (for example, considerds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083<\/code><\/strong> shown in the sample POST response) should be used as the query parameter in the GET Method.<\/p>\n
    \r\ncurl --location\r\n'https:\/\/prod-bots.korebots.com\/api\/public\/bot\/st-8xxxxxxc-cxx2-5xxf-axx5-9xxxxxxxxxxb\/taskContainmentReport\/status\/ds-9xxxxxxd-0xx4-5xx8-axx8-axxxxxxxd083<\/code><\/strong>' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'\r\n<\/pre>\n
    Sample Response for the GET Method<\/span><\/h2>\n
    {\r\n   \"tasksExecutionReport\": {\r\n   \"total\": 8,\r\n   \"data\": {\r\n   \"2024-03-07\": [\r\n       {\r\n         \"totalExecution\": 1,\r\n         \"totalSession\": 1,\r\n         \"selfServiceSessions\": 1,\r\n         \"dropOffSessions\": 0,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Tags 1\",\r\n         \"Status\": \"success\",\r\n         \"selfServiceSessionsInPercentage\": 100,\r\n         \"dropOffSessionsInPercentage\": 0,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n      },\r\n      {\r\n         \"totalExecution\": 2,\r\n         \"totalSession\": 2,\r\n         \"selfServiceSessions\": 0,\r\n         \"dropOffSessions\": 0,\r\n         \"agentTransferSessions\": 2,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Agent Transfer\",\r\n         \"Status\": \"success\",\r\n         \"selfServiceSessionsInPercentage\": 0,\r\n         \"dropOffSessionsInPercentage\": 0,\r\n         \"agentTransferSessionsInPercentage\": 100\r\n       },\r\n       {\r\n         \"totalExecution\": 12,\r\n         \"totalSession\": 6,\r\n         \"selfServiceSessions\": 2,\r\n         \"dropOffSessions\": 2,\r\n         \"agentTransferSessions\": 2,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Age Predictor\",\r\n         \"Status\": \"success\",\r\n         \"selfServiceSessionsInPercentage\": \"33.33\",\r\n         \"dropOffSessionsInPercentage\": \"33.33\",\r\n         \"agentTransferSessionsInPercentage\": \"33.33\"\r\n       },\r\n       {\r\n         \"totalExecution\": 1,\r\n         \"totalSession\": 1,\r\n         \"selfServiceSessions\": 1,\r\n         \"dropOffSessions\": 0,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Tags 2\",\r\n         \"Status\": \"success\",\r\n         \"selfServiceSessionsInPercentage\": 100,\r\n         \"dropOffSessionsInPercentage\": 0,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n       },\r\n       {\r\n         \"totalExecution\": 1,\r\n         \"totalSession\": 1,\r\n         \"selfServiceSessions\": 1,\r\n         \"dropOffSessions\": 0,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Phone Number Verification\",\r\n         \"Status\": \"failtask\",\r\n         \"selfServiceSessionsInPercentage\": 100,\r\n         \"dropOffSessionsInPercentage\": 0,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n       },\r\n       {\r\n         \"totalExecution\": 1,\r\n         \"totalSession\": 1,\r\n         \"selfServiceSessions\": 0,\r\n         \"dropOffSessions\": 1,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Create Booking\",\r\n         \"Status\": \"failtask\",\r\n         \"selfServiceSessionsInPercentage\": 0,\r\n         \"dropOffSessionsInPercentage\": 100,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n       },\r\n       {\r\n         \"totalExecution\": 2,\r\n         \"totalSession\": 2,\r\n         \"selfServiceSessions\": 0,\r\n         \"dropOffSessions\": 2,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Age Predictor\",\r\n         \"Status\": \"failtask\",\r\n         \"selfServiceSessionsInPercentage\": 0,\r\n         \"dropOffSessionsInPercentage\": 100,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n       },\r\n       {\r\n         \"totalExecution\": 1,\r\n         \"totalSession\": 1,\r\n         \"selfServiceSessions\": 1,\r\n         \"dropOffSessions\": 0,\r\n         \"agentTransferSessions\": 0,\r\n         \"dateRange\": \"2024-03-07\",\r\n         \"taskType\": \"dialog\",\r\n         \"taskName\": \"Currency\",\r\n         \"Status\": \"success\",\r\n         \"selfServiceSessionsInPercentage\": 100,\r\n         \"dropOffSessionsInPercentage\": 0,\r\n         \"agentTransferSessionsInPercentage\": 0\r\n        }\r\n      ]\r\n    }\r\n  },\r\n  \"status\": \"SUCCESS\"\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Response Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    totalExecution<\/span><\/td>\nThe overall count of the successful or failed tasks executed for a conversation session.<\/span><\/td>\n<\/tr>\n
    totalSession<\/span><\/td>\nTotal number of conversation sessions during which the specified task is executed.\u00a0\u00a0<\/span><\/p>\n
    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.<\/span><\/td>\n<\/tr>\n
    selfServiceSessions<\/span><\/td>\nTotal number of conversation sessions that are marked as Self-service during which the specified task is executed (Success or Failure).<\/span><\/p>\n
    Self-service sessions refer to the conversations that the virtual assistant contains.<\/td>\n<\/tr>\n
    dropOffSessions<\/span><\/td>\nTotal number of conversation sessions that are marked as Drop-off during which the specified task is executed (Success or Failure).<\/span><\/p>\n
    A session is classified as <\/span>Drop-off<\/span><\/i> when the user abandons the conversation in one of the following scenarios:<\/span><\/p>\n
      \n
    • Leaves the conversation abruptly without completing the task.<\/span><\/li>\n
    • Leaves the conversation after the task resulted in a failure.<\/span><\/li>\n
    • The last utterance of the user does not detect any intent.<\/span><\/li>\n
    • The virtual assistant stops responding due to any reason.<\/span><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    agentTransferSessions<\/span><\/td>\nThe total number of conversation sessions marked as Agent Transfer during which the specified task is executed (Success or Failure).<\/span><\/p>\n
    A session is classified as an<\/span> Agent Transfer<\/span><\/i> if the conversation leads to an agent transfer in a session.<\/span><\/td>\n<\/tr>\n
    dateRange<\/span><\/td>\nThe date range based on the selected <\/span>\u201c<\/span>dateFrom<\/span><\/em>\u201d and \u201c<\/span>dateTo<\/span><\/em>\u201d values.<\/span><\/td>\n<\/tr>\n
    taskType<\/span><\/td>\nThe type of task executed for a conversation session. The task executed can be a Dialog, Alert task, FAQ.<\/span><\/td>\n<\/tr>\n
    taskName<\/span><\/td>\nName of the task executed, including Dialog Tasks, Alert Tasks, and FAQs.<\/span><\/td>\n<\/tr>\n
    Status<\/span><\/td>\nTasks that are successfully executed are marked as ‘Success’. Unsuccessful tasks, including drop-off, are marked as \u2018Failure\u2019.<\/span><\/span><\/td>\n<\/tr>\n
    selfServiceSessionsInPercentage<\/span><\/td>\nThe percentage of sessions that are classified as <\/span>Self-Service<\/span><\/i> out of the total number of sessions that are displayed for a task status.<\/span><\/td>\n<\/tr>\n
    dropOffSessionsInPercentage<\/span><\/td>\nThe percentage of sessions that are classified as <\/span>drop-off<\/span><\/i> out of the total number of sessions that are displayed for a task status.<\/span><\/td>\n<\/tr>\n
    agentTransferSessionsInPercentage<\/span><\/td>\nThe 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.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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\u2019s a combination of POST and GET methods....","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-61448","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61448","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=61448"}],"version-history":[{"count":28,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61448\/revisions"}],"predecessor-version":[{"id":61603,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/61448\/revisions\/61603"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=61448"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=61448"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=61448"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}