Skip to content
vocapable.Docs

Which knowledge sections were suggested, pinned, dismissed and thumbed

GET
/v1/workspace/contact-center/assist/usage
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/assist/usage \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
since
Any of:
string format: date-time
until
Any of:
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcAssistUsage
object
since
required
Since
string format: date-time
until
required
Until
string format: date-time
rows
required
Rows
Array<object>
CcAssistUsageRow
object
pack_id
required
Pack Id
string
section_index
required
Section Index
integer
title
required
Title
string
source_label
required
Source Label
string
shown
required
Shown
integer
pinned
required
Pinned
integer
dismissed
required
Dismissed
integer
helpful
required
Helpful
integer
not_helpful
required
Not Helpful
integer
median_latency_ms
required
Any of:
integer
latency_budget_ms
required
Latency Budget Ms
integer
Examplegenerated
{
  "since": "2026-04-15T12:00:00Z",
  "until": "2026-04-15T12:00:00Z",
  "rows": [
    {
      "pack_id": "example",
      "section_index": 1,
      "title": "example",
      "source_label": "example",
      "shown": 1,
      "pinned": 1,
      "dismissed": 1,
      "helpful": 1,
      "not_helpful": 1,
      "median_latency_ms": 1
    }
  ],
  "latency_budget_ms": 1
}

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