Skip to content
vocapable.Docs

One evaluation (an agent's view is audited)

GET
/v1/workspace/quality/evaluations/{evaluation_id}
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/quality/evaluations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
evaluation_id
required
Evaluation Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualityEvaluation
object
id
required
Id
string
scorecard_id
required
Scorecard Id
string
scorecard_name
required
Scorecard Name
string
scorecard_version
required
Scorecard Version
integer
call
required
QualityEvaluationCall
object
workspace_call_id
required
Any of:
string
ai_call_id
required
Any of:
string
direction
required
Direction
string
Allowed values: inbound outbound
queue_key
required
Any of:
string
call_at
required
Call At
string format: date-time
conversation_id
Any of:
string
channel
Channel
string
default: voice
Allowed values: voice sms
subject_kind
required
Subject Kind
string
Allowed values: person ai_agent
subject
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
score_source
required
Score Source
string
Allowed values: human ai
label
required
Label
string
evaluator
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
status
required
Status
string
Allowed values: draft submitted acknowledged completed needs_review reviewed
score
required
Any of:
number
raw_score
required
Any of:
number
auto_failed
required
Auto Failed
boolean
answered
required
Answered
integer
needs_review_count
required
Needs Review Count
integer
calibration_session_id
required
Any of:
string
reviews_evaluation_id
required
Any of:
string
submitted_at
required
Any of:
string format: date-time
ack_due_at
required
Any of:
string format: date-time
acknowledged_at
required
Any of:
string format: date-time
open_disputes
required
Open Disputes
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
auto_fail_questions
required
Auto Fail Questions
Array<string>
model
required
Any of:
string
sections
required
Sections
Array<object>
QualitySection
object
key
required
Key
string
title
required
Title
string
weight
required
Weight
integer
questions
required
Questions
Array<object>
QualityQuestion
object
key
required
Key
string
text
required
Text
string
type
required
Type
string
Allowed values: yes_no scale
weight
required
Weight
integer
allow_na
required
Allow Na
boolean
auto_fail
required
Auto Fail
boolean
guidance
required
Any of:
string
fingerprint
required
Fingerprint
string
points
required
Points
number
answers
required
Answers
Array<object>
QualityAnswer
object
question_key
required
Question Key
string
section_key
required
Section Key
string
text
required
Text
string
type
required
Type
string
Allowed values: yes_no scale
value
required
Value
string
Allowed values: yes no na 1 2 3 4 5
source
required
Source
string
Allowed values: human ai
label
required
Label
string
auto_scored
required
Auto Scored
boolean
needs_review
required
Needs Review
boolean
earned
required
Any of:
number
possible
required
Any of:
number
comment
required
Any of:
string
evidence
required
Evidence
Array<object>
QualityEvidence
object
quote
required
Quote
string
turn_seq
required
Turn Seq
integer
at_ms
required
At Ms
integer
message_id
Any of:
string
at
Any of:
string format: date-time
agreement
required
Any of:
QualityAgreementFigure
object
calibrated_calls
required
Calibrated Calls
integer
agreement
required
Any of:
number
kappa
required
Any of:
number
auto_score
required
Auto Score
boolean
ai_value
required
Any of:
string
Allowed values: yes no na 1 2 3 4 5
amended_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
amended_at
required
Any of:
string format: date-time
comments
required
Comments
Array<object>
QualityComment
object
id
required
Id
string
author
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
at_ms
required
Any of:
integer
body
required
Body
string
created_at
required
Created At
string format: date-time
disputes
required
Disputes
Array<object>
QualityDispute
object
id
required
Id
string
evaluation_id
required
Evaluation Id
string
question_key
required
Question Key
string
question_text
required
Question Text
string
raised_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
comment
required
Comment
string
status
required
Status
string
Allowed values: open upheld amended
due_at
required
Due At
string format: date-time
overdue
required
Overdue
boolean
resolver
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
resolution_comment
required
Any of:
string
before_value
required
Before Value
string
Allowed values: yes no na 1 2 3 4 5
after_value
required
Any of:
string
Allowed values: yes no na 1 2 3 4 5
before_score
required
Any of:
number
after_score
required
Any of:
number
resolved_at
required
Any of:
string format: date-time
can_resolve
required
Can Resolve
boolean
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
actions
required
Actions
Array<string>
Allowed values: edit submit acknowledge dispute comment review coach
ai_generated
required
Ai Generated
boolean
conversation
Any of:
QualityConversationOutcome

How a routed text conversation ended (CC8-R1): the close disposition and note the agent recorded, who closed it and when - context beside the scorecard.

object
conversation_id
required
Conversation Id
string
queue_id
required
Queue Id
string
queue_name
required
Any of:
string
close_reason
required
Any of:
string
disposition
required
Any of:
string
close_note
required
Any of:
string
closed_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
closed_at
required
Any of:
string format: date-time
accepted_at
required
Any of:
string format: date-time
first_response_at
required
Any of:
string format: date-time
dialer
Any of:
QualityDialerOutcome

The outbound-dialer facts of a call the dialer placed (CC4): its campaign and the disposition the agent (or the dialer itself) recorded - context for the evaluator.

object
campaign_id
required
Campaign Id
string
campaign_name
required
Campaign Name
string
disposition
required
Any of:
string
disposition_label
required
Any of:
string
Example
{
  "call": {
    "direction": "inbound",
    "channel": "voice"
  },
  "subject_kind": "person",
  "score_source": "human",
  "status": "draft",
  "sections": [
    {
      "questions": [
        {
          "type": "yes_no"
        }
      ]
    }
  ],
  "answers": [
    {
      "type": "yes_no",
      "value": "yes",
      "source": "human",
      "ai_value": "yes"
    }
  ],
  "disputes": [
    {
      "status": "open",
      "before_value": "yes",
      "after_value": "yes"
    }
  ],
  "actions": [
    "edit"
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}