Auto QA Reporting API¶
This API provides reporting interaction level Auto QA scoring and qualification of metrics relevant to the interaction based on the form associated with the QA.
| METHOD | POST |
| Endpoint | https://{{host}}//api/public/QualityManagement/account/{{accountId}}/v1/ScoreReporting
|
| Content Type | application/json
|
| Authorization | auth: {{JWT}}
|
| API Scope | Quality AI |
Path Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| host | Environment URL. For example, https://platform.kore.ai/ | string, required |
| accountId | The Account Id. For example, 665ae2f3cc61d7d2cf75xxxx
|
string, required |
Sample Request¶
curl --location 'https://platform.kore.ai/agentassist/api/v1/public/qualitymanagement/app/st-c35c438e-b95a-51d6-9b44-b8691a9eaeb6/scorereporting' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImNzLTI5YjhlZmY3LWNhZmItNTkzYS1hNDU4LTAzYWQwZjA4ZGM5XXXX.bxF1rOd6TLmwetSHGHcHvWw6nK8e3hzULpkItYZmcqE' \
--header 'accountId: 665ae2f3cc61d7d2cf75xxxx' \
--header 'Content-Type: application/json' \
--data '{
"offset": 0,
"startDate": "2024-06-26 00:18:30",
"endDate": "2024-06-26 13:36:35",
"limit": 70
}'
Body Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| offset | The number of responses the documents need to Skip. The default value is 0. For example, 10. | Integer, optional |
| limit | The number of conversation records to be displayed in the response. The default value is 100. For example, 70. | Integer, optional |
| startDate | The start date from which the records need to be considered.
The date format with UTC based time:
For Example, |
string, required |
| endtDate | The end date from which the records need to be considered.
The date format with UTC based time:
For Example, |
string, required |
| channel | Option to filter interactions by channel. | array, optional |
| queues | Options to filter interactions by queue. | array, optional |
Sample Response¶
{
"results": [
{
"conversationId": "c-15ae6dc-7644-4bba-9ac9-d2092e51xxxx",
"koreEvalutionScore": 75,
"Queues": [
{
"Queue ID": "qu-eb08edd-b55e-47c2-9328-9b1d5210xxxx",
"Queue Name": "Default Queue"
}
],
"Agents": [
{
"Agent ID": "a-94cb2bb-78a2-4855-ab4d-3ba28ae8xxxxx",
"Agent Name": "Prod1"
}
],
"Metrics": [
{
"Metric ID": "em-aac5e0fe-22e3-590b-840a-ee190342xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-3f56aa0a-fa87-5a79-91cb-855696c7xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-b305192c-370f-5d61-a5d5-fa68f560xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-12983a0d-4177-5ad4-9dda-36d828eexxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-11656752-cec8-5177-819c-5565e63cxxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-8d7b3953-c329-5bb8-a08d-d945a253xxxx",
"Metric Name": "Pre-Authorization query - Cigna",
"Metric Weight": 10,
"Qualification": "NO"
},
{
"Metric ID": "em-32254731-8cf5-5eca-89f1-95ef860axxxx",
"Metric Name": "Pre-Authorization Procedure - Cigna",
"Metric Weight": 15,
"Qualification": "NO"
},
{
"Metric ID": "em-1a289207-fb66-5ec8-b0a5-be63a440xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-a35b103a-27ef-55e6-82d9-76ed3fe6xxxx",
"Qualification": "YES"
}
]
},
{
"conversationId": "c-6200bc7-74c5-4404-a806-a7b811b1xxxx",
"koreEvalutionScore": 80,
"Queues": [
{
"Queue ID": "qu-eb08edd-b55e-47c2-9328-9b1d5210xxxx",
"Queue Name": "Default Queue"
}
],
"Agents": [
{
"Agent ID": "a-94cb2bb-78a2-4855-ab4d-3ba28ae8xxxxx",
"Agent Name": "Prod1"
}
],
"Metrics": [
{
"Metric ID": "em-aac5e0fe-22e3-590b-840a-ee190342xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-3f56aa0a-fa87-5a79-91cb-855696c7xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-b305192c-370f-5d61-a5d5-fa68f560xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-12983a0d-4177-5ad4-9dda-36d828eexxxx",
"Qualification": "NO"
},
{
"Metric ID": "em-11656752-cec8-5177-819c-5565e63cxxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-8d7b3953-c329-5bb8-a08d-d945a253xxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-32254731-8cf5-5eca-89f1-95ef860axxxx",
"Qualification": "YES"
},
{
"Metric ID": "em-1a289207-fb66-5ec8-b0a5-be63a440xxxx",
"Metric Name": "Additional Assistance - Cigna",
"Metric Weight": 5,
"Qualification": "NO"
},
{
"Metric ID": "em-a35b103a-27ef-55e6-82d9-76ed3fe6xxxx",
"Qualification": "YES"
}
]
},
{
"conversationId": "c-b1e19cd-3ce7-44da-8479-02877687xxxx",
"koreEvalutionScore": 30,
"Queues": [
{
"Queue ID": "qu-eb08edd-b55e-47c2-9328-9b1d5210xxxx",
"Queue Name": "Default Queue"
}
],
"Agents": [
{
"Agent ID": "a-94cb2bb-78a2-4855-ab4d-3ba28ae8xxxxx",
"Agent Name": "Prod1"
}
],
"Metrics": [
{
"Metric ID": "em-d6cef34e-601a-5933-984f-3d59027dxxxx",
"Metric Name": "greeting",
"Metric Weight": 50,
"Qualification": "NO"
},
{
"Metric ID": "em-4b7ce74e-fa15-5e9e-96ff-ddbe9f96xxxx",
"Metric Name": "proper sign off",
"Metric Weight": 20,
"Qualification": "NO"
},
{
"Metric ID": "em-09959e02-601a-54c5-a14c-c788bc7exxxx",
"Qualification": "YES"
}
]
}
],
"totalResults": 3,
"totalPages": 1,
"hasMore": false
}
Response Body Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| conversationId | The conversation id of the record. | string |
| koreEvalutionScore | The score returned by NLP for that conversation. | string |
| queues | Queue details for the conversation. | string |
| Queue ID | Queue id of the conversation. | string |
| Queue Name | Queue name of the conversation. | string |
| agents | Array of agents who have participated in the conversation. | string |
| Agent ID | Agent ID of the conversation. | string |
| Agent Name | List of agents names who have participated in the conversation. | string |
| metric | An array of evaluation metrics with which scores are calculated. | array |
| Metric ID | Unique identifier for the metric. | string |
| Metric Weight | A numerical value indicating how much influence or impact that metric has in an overall evaluation or scoring system. | integer |
| Qualification | Qualification status (YES or NO) | boolean |