Viewing Evaluations

Description

Retrieves evaluation data based on a specific agent team (agentTeamId) or agent (agentUserId) with releases status.

Business Application

Used by Quality Assurance teams to monitor Agent Performance and compliance. Aggregating this data provides insights into training needs and overall service quality.

Endpoint

GET https://api.mypurecloud.de/api/v2/quality/evaluations/query

Request

Headers

• Authorization: Bearer Token
• Content-Type: application/json

Query Parameters

Name	Type	Mandatory	Description
agentTeamId	String	Yes*	Primary: ID of the agent team. Recommended for high-level management views.
agentUserId	String	No*	Alternative: ID of a specific agent. Use this for drill-down views or single-agent reports.
isReleased	Boolean	Yes	Set to true to fetch only released (post-draft) evaluations
expandAnswerTotalScores	Boolean	Yes	Set to true to show full evaluation scores
pageSize	Number	Yes	Requested page size
pageNumber	Number	Yes	Requested page number

Sample URL

https://api.mypurecloud.de/api/v2/quality/evaluations/query?pageSize=1&pageNumber=1&agentTeamId=<TEAM_ID>&isReleased=true&expandAnswerTotalScores=true

CURL Example

curl -X GET 'https://api.mypurecloud.de/api/v2/quality/evaluations/query?pageSize=1&pageNumber=1&agentTeamId=<TEAM_ID>&isReleased=true&expandAnswerTotalScores=true' \
  -H 'Authorization: Bearer *******************' \
  -H 'Content-Type: application/json'

Response

Body Parameters

Name	Type	Description
entities	Array	Array of evaluation objects
id	String	Evaluation ID
status	String	Status of the evaluation (e.g., "FINISHED")
answers	Object	object containing totalScore, totalCriticalScore, etc.

Sample Response

{
    "entities": [
        {
            "id": "<EVALUATION_ID>",
            "status": "FINISHED",
            "answers": {
                "totalScore": 100.0,
                "totalCriticalScore": 100.0
            }
        }
    ],
    "total": 99,
    "pageCount": 99
}