Skip to content
Vocapable Developers

Read bounded aggregate receptionist metrics

GET
/v1/mobile/receptionist/metrics
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/receptionist/metrics \
  --header 'Authorization: Bearer <token>'

Return compact operational counts without exposing the calls behind the totals.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

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

Inclusive lower bound, ISO-8601. The report requires a half-open [start, end) window and may span at most 93 days.

end
Any of:
string format: date-time

Exclusive upper bound, ISO-8601.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileReceptionistMetrics

A bounded, aggregate-only receptionist operations report.

The response is a single tenant-wide total for the half-open [start, end) window; it never exposes source call, contact, carrier, appointment, or transfer rows. Each handoff count is attributed to the durable lifecycle timestamp named by the field, rather than to the request’s current status.

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
inbound_calls_received
required
Inbound Calls Received
integer
handoffs_requested
required
Handoffs Requested
integer
handoffs_accepted
required
Handoffs Accepted
integer
handoffs_redirected
required
Handoffs Redirected
integer
handoffs_completed
required
Handoffs Completed
integer
handoffs_declined
required
Handoffs Declined
integer
handoffs_timed_out
required
Handoffs Timed Out
integer
handoffs_failed
required
Handoffs Failed
integer
appointments_created
required
Appointments Created
integer
Examplegenerated
{
  "start": "2026-04-15T12:00:00Z",
  "end": "2026-04-15T12:00:00Z",
  "inbound_calls_received": 1,
  "handoffs_requested": 1,
  "handoffs_accepted": 1,
  "handoffs_redirected": 1,
  "handoffs_completed": 1,
  "handoffs_declined": 1,
  "handoffs_timed_out": 1,
  "handoffs_failed": 1,
  "appointments_created": 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": {}
    }
  ]
}