Skip to main content
GET
/
quality
/
scorecard
/
{id}
Get a specific quality scorecard
curl --request GET \
  --url https://demo.enneo.ai/api/mind/quality/scorecard/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 42,
  "baseId": 17,
  "revision": 3,
  "name": "Email QA - Tier 1",
  "state": "active",
  "categories": [
    {
      "categoryId": 1,
      "label": "Opening",
      "order": 1,
      "criteria": [
        {
          "id": 10,
          "label": "Greeting",
          "description": "Did the agent greet the customer properly?",
          "maxPoints": 5,
          "scoringType": "numericScale",
          "autoGenerateByAi": false,
          "assessmentPrompt": "Evaluate the opening.",
          "makeOrBreakForCategory": false,
          "makeOrBreakForAssessment": false
        }
      ]
    }
  ],
  "assignment": {
    "ticketTags": [
      101,
      102
    ],
    "teams": [
      5
    ],
    "channels": [
      "email"
    ]
  },
  "createdAt": "2024-05-12T09:41:00Z",
  "modifiedAt": "2024-06-01T10:00:00Z",
  "canEdit": true
}

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

Scorecard ID

Response

Successful operation

Quality scorecard for assessing agent performance

​
id
integer

Scorecard ID

Example:

1

​
baseId
integer

Base ID for versioning (stable across revisions)

Example:

1

​
revision
integer

Revision number

Example:

1

​
name
string

Scorecard name

Example:

"Junior agent standard review"

​
state
enum<string>

Scorecard state

Available options:
draft,
active,
retired,
deleted
Example:

"active"

​
categoryCount
integer

Number of categories (summary format only)

Example:

3

​
categories
object[]

Scorecard categories with criteria (full format only)

​
assignment
object

Assignment rules for scorecard applicability

​
liveCoach
object

Live Quality Coach configuration. When enabled is true and this scorecard is applicable to the ticket, the real-time draft check (POST /ticket/{id}/quality/check) scores against it and the server-side send gate blocks replies whose score is below threshold (unless the user has qualityBypassSendGate).

​
createdBy
integer

User ID who created the scorecard

​
modifiedBy
integer

User ID who last modified the scorecard

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

Whether current user can edit this scorecard