Skip to content
vocapable.Docs

QA reports by agent, team, queue, scorecard, direction, channel or question

GET
/v1/workspace/quality/reports
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/quality/reports?group_by=agent' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
group_by
Group By
string
default: agent
Allowed values: agent queue scorecard direction question team channel
start
Any of:
string format: date-time
end
Any of:
string format: date-time
scorecard_id
Any of:
string
<= 64 characters
agent_user_id
Any of:
string
<= 64 characters
channel
Any of:
string
Allowed values: voice sms

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualityReport
object
group_by
required
Group By
string
Allowed values: agent queue scorecard direction question team channel
start
required
Start
string format: date-time
end
required
End
string format: date-time
rows
required
Rows
Array<object>
QualityReportRow
object
group_key
required
Any of:
string
label
required
Label
string
score_source
required
Score Source
string
Allowed values: human ai
evaluations
required
Evaluations
integer
average_score
required
Any of:
number
auto_failed
required
Auto Failed
integer
questions
required
Questions
Array<object>
QualityQuestionReportRow
object
scorecard_id
required
Scorecard Id
string
question_key
required
Question Key
string
text
required
Text
string
score_source
required
Score Source
string
Allowed values: human ai
answered
required
Answered
integer
average_credit
required
Any of:
number
na
required
Na
integer
trend
required
Trend
Array<object>
QualityTrendPoint
object
week_start
required
Week Start
string format: date-time
score_source
required
Score Source
string
Allowed values: human ai
evaluations
required
Evaluations
integer
average_score
required
Any of:
number
scope
required
Scope
string
Allowed values: self team
policy_note
required
Policy Note
string
Example
{
  "group_by": "agent",
  "rows": [
    {
      "score_source": "human"
    }
  ],
  "questions": [
    {
      "score_source": "human"
    }
  ],
  "trend": [
    {
      "score_source": "human"
    }
  ],
  "scope": "self"
}

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": {}
    }
  ]
}