Get the Execution Status and Summary of a Test Suite API¶
To get the status of the Conversation Test Suite Execution request against a unique testSuiteId if the request is in progress, and provide the download link for the results file after the test execution is complete.
| Method | GET |
| Endpoint | https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/:testRunId/status
|
| Content Type | application/json
|
| Authorization | auth: {{JWT}}
|
| API Scope |
|
Query Parameters¶
| PARAMETER | DESCRIPTION | MANDATE |
| host | Environment URL. For example,https://bots.kore.ai
|
Required |
| StreamID | The Stream ID can be accessed under General Settings on the Bot Builder. | Required |
| testSuiteName | The name of the Test Suite. | Required |
| testRunId | The ID of the test run to track the execution status. | Required |
Sample Request¶
curl --location --request GET \
'https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/:testRunId/status' \
--header 'auth: {YOUR_JWT_ACCESS_TOKEN}' \
--header 'bot-language: {language-code}'
Body Parameters¶
No Body parameters are passed.
Sample Response¶
- When the request in in progress.
{
"_id": "ctr-80xxxxxa-bxx1-5xx1-axx7-d5xxxxxxxxxb",
"streamId": "st-4xxxxxx7-3xx4-5xxa-9xxa-d8xxxxxxxxx0",
"testSuiteId": "ctc-3xxxxxx5-6xxf-5xxb-bxx8-04xxxxxxxxxc",
"status": "inprogress",
"totalTestStepsCount": 13,
"result": {
"nlpVersion": [],
"startTime": "2023-08-23T10:14:13.330Z",
"version": "configured",
"status": "inprogress"
},
"percentageCompleted": 85
}
- When the request is completed.
{
"_id": "ctr-8xxxxxxa-bxx1-5xx1-axx7-d5xxxxxxxxxb",
"streamId": "st-4xxxxxx7-3xx4-5xxa-9xxa-d8xxxxxxxxx0",
"testSuiteId": "ctc-3xxxxxx5-6xxf-5xxb-bxx8-04xxxxxxxxxc",
"status": "passed",
"totalTestStepsCount": 13,
"result": {
"nlpVersion": [
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3",
"v3"
],
"startTime": "2023-08-23T10:14:13.330Z",
"version": "configured",
"status": "passed",
"stepDetails": {
"passed": 13,
"failed": 0,
"total": 13
},
"errorDetails": null,
"executionResults": [ {
"actualOutput": [
{
"text": "asdasd",
"nodeId": "",
"componentType": "",
"intentId": "",
"nodeName": "",
"intentType": "",
"taskId": "",
"dialogName": "",
"transitions": [],
"transitionNodeNames": [],
"transitionNodeType": [],
"assertions": {
"flowLevel": {
"enabled": false,
"contains": []
},
"text": {
"enabled": true,
"contains": [
{
"text": "asdasd",
"status": "passed"
}
],
"status": "passed"
},
"context": {
"enabled": false,
"contains": []
}
}
}
],
"intents": [],
"faqs": [],
"smalltalk": [],
"input": "Start_Flow",
"outputs": [
{
"text": "asdasd",
"nodeId": "",
"componentType": "",
"intentId": "",
"nodeName": "",
"intentType": "",
"taskId": "",
"dialogName": "",
"transitions": [],
"transitionNodeNames": [],
"transitionNodeType": [],
"assertions": {
"flowLevel": {
"enabled": false,
"contains": []
},
"text": {
"enabled": true,
"contains": [
{
"text": "asdasd",
"status": "passed"
}
],
"status": "passed"
},
"context": {
"enabled": false,
"contains": []
}
}
}
],
"event": "Start_Flow",
"requestId": "ctr-8xxxxxxa-bxx1-5xx1-axx7-d5xxxxxxxxxx0",
"nlpVersion": "v3",
"status": "passed"
},
{
"actualOutput": [
{
"text": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Sorry! We are unable to detect the language. Please choose one of the below languages :\\n\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"English\",\"payload\":\"English\"},{\"content_type\":\"text\",\"title\":\"Deutsch\",\"payload\":\"Deutsch\"}]}}",
"category": "Confirmation",
"isStandardResponse": true,
"userPrompts": [],
"assertions": {
"flowLevel": {
"enabled": true,
"contains": [
{
"nodeId": "Confirmation",
"status": "passed"
}
],
"status": "passed"
},
"text": {
"enabled": true,
"contains": [
{
"text": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Sorry! We are unable to detect the language. Please choose one of the below languages :\\n\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"English\",\"payload\":\"English\"},{\"content_type\":\"text\",\"title\":\"Deutsch\",\"payload\":\"Deutsch\"}]}}",
"status": "passed"
}
],
"status": "passed"
},
"context": {
"enabled": false,
"contains": []
}
}
}
],
"intents": [],
"faqs": [],
"smalltalk": [],
"input": "help",
"outputs": [
{
"text": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Sorry! We are unable to detect the language. Please choose one of the below languages :\\n\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"English\",\"payload\":\"English\"},{\"content_type\":\"text\",\"title\":\"Deutsch\",\"payload\":\"Deutsch\"}]}}",
"category": "Confirmation",
"isStandardResponse": true,
"userPrompts": [],
"assertions": {
"flowLevel": {
"enabled": true,
"contains": [
{
"nodeId": "Confirmation",
"status": "passed"
}
],
"status": "passed"
},
"text": {
"enabled": true,
"contains": [
{
"text": "{\"type\":\"template\",\"payload\":{\"template_type\":\"quick_replies\",\"text\":\"Sorry! We are unable to detect the language. Please choose one of the below languages :\\n\",\"quick_replies\":[{\"content_type\":\"text\",\"title\":\"English\",\"payload\":\"English\"},{\"content_type\":\"text\",\"title\":\"Deutsch\",\"payload\":\"Deutsch\"}]}}",
"status": "passed"
}
],
"status": "passed"
},
"context": {
"enabled": false,
"contains": []
}
},
"textMismatch": true
}
],
"requestId": "ctr-8xxxxxxa-bxx1-5xx1-axx7-d5xxxxxxxxxx1",
"nlpVersion": "v3",
"status": "passed"
}
......................................................................................
],
"duration": 14364
},
"percentageCompleted": 100
}