{"id":26899,"date":"2021-02-19T09:33:57","date_gmt":"2021-02-19T09:33:57","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=26899"},"modified":"2022-12-01T09:44:21","modified_gmt":"2022-12-01T09:44:21","slug":"batch-test-execution-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/api-guide\/batch-test-execution-status-api\/","title":{"rendered":"Batch Test Execution Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To get the status of the Batch Test Execution request against a unique \u2018Request Id\u2019 and provide the download link for the results file after the test execution is complete. Please refer to the Batch Test Execution API<\/a> to learn more.<\/span><\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{host}\/api\/public\/bot\/{botId}\/testsuite\/{testSuiteName}\/{testRunId}\/status<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\n\n

auth: {{JWT}}<\/code><\/p>\n

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

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Batch Tests Execution<\/li>\n
  • Admin Console: Not Applicable<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nDescription<\/th>\nMandate<\/th>\n<\/tr>\n<\/thead>\n
    host<\/b><\/span><\/td>\nEnvironment URL, for example,https:\/\/bots.kore.ai<\/code><\/span><\/td>\n\n

    Required<\/p>\n<\/tr>\n

    BotID<\/b><\/td>\nThe Bot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/span><\/td>\nRequired<\/td>\n<\/tr>\n
    testSuiteName<\/b><\/td>\nName of the test suite as created in the Bot\u2019s platform that is being executed<\/span><\/td>\n\n

    Required<\/p>\n<\/tr>\n

    testRunId<\/b><\/td>\nThe unique \u2018Request ID\u2019 returned by the Batch Test Execution API to track the progress <\/span><\/td>\n\n

    Required<\/p>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl --location --request GET \\\r\n  'https:\/\/{host}\/api\/public\/stream\/{streamId}\/testsuite\/{testSuiteName}\/{testRunId}\/status' \\\r\n    --header 'auth: {jwt-token}' \\\r\n    --header 'bot-language: {language-code}'\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
     <\/p>\n
    Body Parameters<\/span><\/h2>\n
    No body parameters are passed.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\n
      \n
    • When the test execution is in progress\n
      {\r\n    \"_id\": \"tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa\",\r\n    \"streamId\": \"st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb\",\r\n    \"testSuiteId\": \"ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx\",\r\n    \"status\": \"running\",\r\n    \"utterance_count\": 10,\r\n    \"result\": {\r\n        \"_id\": \"tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa\",\r\n        \"isPartialFailure\": false,\r\n        \"status\": \"running\",\r\n        \"testSuiteId\": \"ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx\",\r\n        \"triggeredBy\": \"u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea\",\r\n        \"streamId\": \"st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb\",\r\n        \"botLanguage\": \"en\",\r\n        \"runType\": \"inDevelopment\",\r\n        \"utterance_count\": 10,\r\n        \"startTime\": \"2021-01-07T17:05:34.509Z\",\r\n        \"__v\": 0\r\n    },\r\n    \"totalUtterances\": 10,\r\n    \"utterance_ran\": 5,\r\n    \"percentage\": 50\r\n}\r\n<\/pre>\n<\/li>\n
    • When the test execution is in progress\n
      {\r\n    \"_id\": \"tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa\",\r\n    \"streamId\": \"st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb\",\r\n    \"testSuiteId\": \"ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx\",\r\n    \"status\": \"running\",\r\n    \"utterance_count\": 10,\r\n    \"result\": {\r\n        \"_id\": \"tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa\",\r\n        \"isPartialFailure\": false,\r\n        \"status\": \"completed\",\r\n        \"testSuiteId\": \"ts-deaxxxxc-xxxx-xxxe-axbx-bxxcxxxxfxxx\",\r\n        \"triggeredBy\": \"u-xxbdxecd-xxdx-xxex-xxxd-xxdxxxxdxxea\",\r\n        \"streamId\": \"st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb\",\r\n        \"botLanguage\": \"en\",\r\n        \"runType\": \"inDevelopment\",\r\n        \"utterance_count\": 10,\r\n        \"startTime\": \"2021-01-07T17:05:34.509Z\",\r\n        \"__v\": 0\r\n        \"endTime\": \"2021-01-07T17:07:37.544Z\",\r\n        \"f1_score\": \"0.00\",\r\n        \"fileId\": \"5ff73fd98a3d9a5cbbd7c32b\",\r\n        \"precision\": \"0.00\",\r\n        \"recall\": \"0.00\",\r\n        \"results\": {\r\n            \"TP\": 0,\r\n            \"TN\": 0,\r\n            \"FP\": 0,\r\n            \"FN\": 0,\r\n            \"success\": 0,\r\n            \"failure\": 10,\r\n            \"totalEntitiesCount\": 0,\r\n            \"matchedEntitiesCount\": 0,\r\n            \"failedUtteranceCount\": 10,\r\n            \"failedEntitiesCount\": 0\r\n        },\r\n        \"fileUrl\": \"{{url}}\"\r\n    }\r\n}\r\n<\/pre>\n<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To get the status of the Batch Test Execution request against a unique \u2018Request Id\u2019 and provide the download link for the results file after the test execution is complete. Please refer to the Batch Test Execution API to learn more.   Method GET Endpoint https:\/\/{host}\/api\/public\/bot\/{botId}\/testsuite\/{testSuiteName}\/{testRunId}\/status Content Type application\/json Authorization auth: {{JWT}} See How to...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-26899","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/26899","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=26899"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/26899\/revisions"}],"predecessor-version":[{"id":49458,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/26899\/revisions\/49458"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=26899"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=26899"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=26899"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}