Skip to content
vocapable.Docs

Phone figures for a period, with definitions

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
period
Period
string
default: 7d
Allowed values: today 7d 30d month
tz
Any of:
string
<= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PhoneReport
object
window
required
WorkspaceReportWindow
object
period
required
Period
string
Allowed values: today 7d 30d month
timezone
required
Timezone
string
start
required
Start
string format: date-time
end
required
End
string format: date-time
label
required
Label
string
figures
required
Figures
Array<object>
PhoneReportFigure
object
key
required
Key
string
Allowed values: inbound_calls answer_rate answered_by_team answered_by_ai missed voicemails missed_not_returned average_time_to_answer median_time_to_answer outbound_calls texts_sent texts_failed recordings_reviewed
label
required
Label
string
unit
required
Unit
string
Allowed values: count basis_points seconds
value
required
Any of:
integer
sample_size
required
Any of:
integer
definition
required
Definition
string
by_line_day
required
By Line Day
Array<object>
PhoneReportLineDay
object
day
required
Day
string
line_id
required
Any of:
string
line_name
required
Line Name
string
inbound
required
Inbound
integer
outbound
required
Outbound
integer
Example
{
  "window": {
    "period": "today"
  },
  "figures": [
    {
      "key": "inbound_calls",
      "unit": "count"
    }
  ]
}

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