Skip to main content
PATCH
/
quality
/
assessment
/
{id}
Update a quality assessment
curl --request PATCH \
  --url https://demo.enneo.ai/api/mind/quality/assessment/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aiSummary": "Updated AI summary after listening to the call.",
  "supervisorAssessment": "Focus on clearer closing.",
  "assessmentDate": "2024-06-12T11:00:00Z",
  "discussionDate": "2024-06-13T09:00:00Z",
  "criteria": [
    {
      "categoryId": 1,
      "criterionId": 2,
      "score": 5,
      "reason": "Great intro"
    },
    {
      "categoryId": 2,
      "criterionId": 6,
      "reason": "Added more context for the closing paragraph."
    }
  ],
  "state": "reviewedBySupervisor"
}
'
{
  "id": 901,
  "scorecardId": 42,
  "scorecardBaseId": 17,
  "state": "reviewedBySupervisor",
  "assessedUser": 23,
  "assessedByUser": 12,
  "ticketId": 8821,
  "worklogId": 551,
  "createdAt": "2024-06-12T10:20:00Z",
  "modifiedAt": "2024-06-12T11:05:00Z",
  "canEdit": true,
  "data": {
    "aiSummary": "Updated AI summary after listening to the call.",
    "categories": [
      {
        "categoryId": 1,
        "criteria": [
          {
            "id": 2,
            "score": 5,
            "reason": "Great intro",
            "state": "humanVerified",
            "lastEditedByUserId": 12,
            "lastEditedAt": "2024-06-12T10:55:00Z"
          }
        ],
        "totals": {
          "scoredPoints": 5,
          "usedMaxPoints": 5,
          "totalMaxPoints": 5,
          "percentage": 100
        }
      },
      {
        "categoryId": 2,
        "criteria": [
          {
            "id": 6,
            "score": 3,
            "reason": "Added more context for the closing paragraph.",
            "state": "humanVerified",
            "lastEditedByUserId": 12,
            "lastEditedAt": "2024-06-12T11:00:00Z"
          }
        ],
        "totals": {
          "scoredPoints": 15,
          "usedMaxPoints": 17,
          "totalMaxPoints": 20,
          "percentage": 88.2
        }
      }
    ],
    "totals": {
      "scoredPoints": 20,
      "usedMaxPoints": 22,
      "totalMaxPoints": 25,
      "percentage": 80
    },
    "supervisorAssessment": "Focus on clearer closing.",
    "assessmentDate": "2024-06-12T11:00:00Z",
    "discussionDate": "2024-06-13T09:00:00Z"
  },
  "worklog": {
    "userId": 23,
    "worklogId": 551,
    "lastInteraction": "2024-06-12T09:59:00Z",
    "ticketId": 8821,
    "conversationId": 331,
    "action": "reply",
    "actionList": [
      "reply",
      "internal-note"
    ]
  },
  "aiUsage": {
    "automationLevel": 2,
    "automationLevelLabel": "Assisted",
    "aiAgents": []
  },
  "time": {
    "duration": 480,
    "durationAfterWork": 120,
    "segments": []
  },
  "customerExperience": {
    "slaMet": true,
    "netSecondsClosedAfterSla": -30,
    "closingDateForSLA": "2024-06-12T09:40:00Z",
    "dueDateForSLA": "2024-06-12T10:00:00Z",
    "reOpened": false,
    "csat": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enneo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT-based authentication

Path Parameters

​
id
integer
required

Assessment ID

Body

application/json
​
aiSummary
string

AI-generated summary (editable by supervisors)

​
supervisorAssessment
string

Supervisor's free-form assessment text

​
assessmentDate
string<date-time>

Date when assessment was completed

​
discussionDate
string<date-time>

Date when assessment was discussed with assessee

​
criteria
object[]

Array of criterion updates

Example:
[
  {
    "categoryId": 1,
    "criterionId": 2,
    "score": 5,
    "reason": "Great intro"
  }
]
​
state
enum<string>

Transition to a new state

Available options:
reviewedBySupervisor,
discussedWithAssessee

Response

Assessment updated successfully

Quality assessment of agent performance on a specific work session

​
id
integer

Assessment ID

Example:

1

​
scorecardId
integer

ID of the scorecard used

Example:

1

​
scorecardBaseId
integer

Base ID of the scorecard used

Example:

1

​
state
enum<string>

Assessment workflow state

Available options:
unprocessed,
aiInProgress,
aiReady,
reviewOngoing,
reviewedBySupervisor,
discussedWithAssessee,
error,
deleted
Example:

"aiReady"

​
assessedUser
integer

ID of the assessed user (agent)

Example:

42

​
assessedByUser
integer | null

ID of the supervisor who assessed

​
ticketId
integer

Related ticket ID

Example:

12345

​
worklogId
integer | null

Related worklog ID

​
aiSummary
string

AI-generated summary (summary format)

Example:

"Good job overall, scored 85%"

​
totals
object

Score totals

​
data
object

Full assessment data (full format only)

​
createdAt
string<date-time>
​
modifiedAt
string<date-time>
​
canEdit
boolean

Whether current user can edit this assessment