Get QM evaluations
Retrieve Quality Management evaluations.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/qm/assessments |
| Options | status, agentIds, evaluatorIds, projectIds, teamIds, lastUserQmId, evaluationDateFrom, evaluationDateTo, callDateFrom, callDateTo |
| Body | /N/A |
| Response | |
| Body | Array of quality management evaluations |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| status | string | no | Specifies the status of quality management evaluations. Possible values: all, active |
| agentIds | array | no | Specifies the list of agents for which quality management evaluations are to be retrieved |
| evaluatorIds | array | no | Specifies the list of evaluators for which quality management evaluations are to be retrieved |
| projectIds | array | no | Specifies the list of projects for which quality management evaluations are to be retrieved |
| teamIds | array | no | Specifies the list of teams for which quality management evaluations are to be retrieved |
| lastUserQmId | integer | no | Specifies the Quality Management evaluation ID from which the response should start |
| evaluationDateFrom | date | yes | The evaluation start date from which evaluations should be returned. format:Y-m-d H:i:s |
| evaluationDateFTo | date | yes | The evaluation end date until which evaluations should be returned. format:Y-m-d H:i:s |
| callDateFrom | date | yes | The call start date from which evaluations should be returned. format:Y-m-d H:i:s |
| callDateTo | date | yes | The call end date until which evaluations should be returned. format:Y-m-d H:i:s |
Please note that:
- At least 1 date parameter is mandatory
- A maximum of 1 month period can be queried in a single request
- The teamIds parameter only works if projectIds is also provided
Response
Response object
| Name | Type | Comment |
|---|---|---|
| projectId | integer | Unique identifier of the project. |
| userQmId | integer | Unique identifier of the QM (Quality Management) record for the user. |
| agentId | integer | Unique identifier of the agent. |
| agentName | string | Name of the agent. |
| evaluatorId | integer | Unique identifier of the evaluator. |
| evaluatorName | string | Name of the evaluator. |
| lastEvaluatorId | integer | Unique identifier of the last evaluator. |
| lastEvaluatorName | string | Name of the last evaluator. |
| scoreDate | string | Date and time when the score was given. |
| scoreDateUtc | string | Date and time when the score was given (UTC). |
| lastScoreDate | string | Date and time of the last scoring update. |
| lastScoreDateUtc | string | Date and time of the last scoring update (UTC). |
| callDate | string | Date and time of the call. |
| callDateUtc | string | Date and time of the call (UTC). |
| readDate | string | null | Date and time when the record was read. |
| readDateUtc | string | null | Date and time when the record was read (UTC). |
| uuid | string | Unique identifier of the call record. |
| disposition | string | Disposition of the call (e.g., “Callback”). |
| status | string | Status of the evaluation (e.g., “active”). |
| score | integer | Total score achieved. |
| version | integer | Version of the evaluation. |
| talkTime | integer | Talk time duration in seconds. |
| numberId | integer | Unique identifier of the customer record. |
| active | boolean | Indicates if the record is active. |
| isRead | boolean | Indicates if the record has been read. |
| description | string | Additional description text. |
| suggestion | string | Suggestion or feedback text. |
| categoryAssessments | array of object | Array of assessment categories related to the evaluation. |
Category assessment object
| Name | Type | Comment |
|---|---|---|
| name | string | Name of the category. |
| description | string | Description of the category. |
| categoryId | integer | Unique identifier of the category. |
| maxValue | integer | Maximum score available for the category. |
| reachedValue | integer | Score reached in this category. |
| reachedPercent | integer | Percentage of score achieved in this category. |
Example
What it does and what information we get using this example.
Request
/qm/assessments?evaluationDateFrom=2017-02-01%2000:00:00&evaluationDateTo=2017-02-28%2020:20:23&agentIds=2,4&projectIds=1,11&lastUserQmId=4
Response body
{
"response": [
{
"projectId": 130,
"userQmId": 33,
"agentId": 8,
"agentName": "John Smith",
"evaluatorId": 6,
"evaluatorName": "Jack Smith",
"lastEvaluatorId": 6,
"lastEvaluatorName": "Jack Smith",
"scoreDate": "2025-03-10 10:15:47",
"scoreDateUtc": "2025-03-10 09:15:47",
"lastScoreDate": "2025-08-26 14:06:48",
"lastScoreDateUtc": "2025-08-26 12:06:48",
"callDate": "2025-03-10 10:14:37",
"callDateUtc": "2025-03-10 09:14:37",
"readDate": null,
"readDateUtc": null,
"uuid": "c0145228-308d-c7bd-f2e0-5671c817d3f6",
"disposition": "Callback",
"status": "active",
"score": 14,
"version": 0,
"talkTime": 3,
"numberId": 1863,
"active": true,
"isRead": false,
"description": "",
"suggestion": "",
"categoryAssessments": [
{
"name": "Introduction",
"description": "",
"categoryId": 1,
"maxValue": 20,
"reachedValue": 14,
"reachedPercent": 70
}
]
}
],
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.