{"id":26899,"date":"2021-02-19T09:33:57","date_gmt":"2021-02-19T09:33:57","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?p=26899"},"modified":"2021-08-23T12:50:19","modified_gmt":"2021-08-23T11:50:19","slug":"batch-test-execution-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/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

Gets the status of Batch Test Execution request against a unique \u2018Request Id\u2019 and provides the download link for the results file after the test execution is complete. Refer here for initiating Batch Test Execution API<\/a>.<\/span><\/p>\n

To use this API, the app needs the Bot Builder Scope of\u00a0Batch Tests Execution<\/em>.<\/p>\n

GET<\/b> https:\/\/{host}\/api\/public\/stream\/{botId}\/testsuite\/{testSuiteName}\/{testRunId}\/status<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example,https:\/\/bots.kore.ai<\/code><\/span><\/td>\n<\/tr>\n
BotID<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/span><\/td>\n<\/tr>\n
testSuiteName<\/td>\nName of the test suite as created in the Bot\u2019s platform that is being executed<\/span><\/td>\n<\/tr>\n
testRunId<\/td>\nThe unique \u2018Request ID\u2019 returned by the Batch Test Execution API to track the progress <\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

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

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response content type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\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
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\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":"Gets the status of Batch Test Execution request against a unique \u2018Request Id\u2019 and provides the download link for the results file after the test execution is complete. Refer here for initiating Batch Test Execution API. To use this API, the app needs the Bot Builder Scope of\u00a0Batch Tests Execution. GET https:\/\/{host}\/api\/public\/stream\/{botId}\/testsuite\/{testSuiteName}\/{testRunId}\/status Query Parameters Parameter...","protected":false},"author":14,"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\/v8-1\/wp-json\/wp\/v2\/posts\/26899","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/14"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=26899"}],"version-history":[{"count":2,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/26899\/revisions"}],"predecessor-version":[{"id":29098,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/26899\/revisions\/29098"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=26899"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=26899"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=26899"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}