Skip to content
Vocapable Developers

Read bounded comparative receptionist insights

GET
/v1/mobile/receptionist/insights
curl --request GET \
  --url 'https://api.vocapable.com/v1/mobile/receptionist/insights?days=7' \
  --header 'Authorization: Bearer <token>'

Return leader-only aggregates for the current and immediately-prior equal window.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
days
Days

Comparison window: 7, 30, or 90 days.

string
default: 7
Allowed values: 7 30 90

Comparison window: 7, 30, or 90 days.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileReceptionistInsights

The complete bounded comparative Insights response for a mobile workspace leader.

object
generated_at
required
Generated At
string format: date-time
days
required
Days
integer
Allowed values: 7 30 90
current_window
required
MobileInsightsWindow

One fixed, half-open comparative interval in UTC.

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
previous_window
required
MobileInsightsWindow

One fixed, half-open comparative interval in UTC.

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
cards
required
Cards
Array<object>
>= 7 items <= 7 items
MobileInsightCard

A finite, aggregate-only comparison card.

Rates are basis points rather than floats (10_000 is 100%) so an API/client cannot accidentally serialize non-finite values. A card is available only when both equal-length windows have a meaningful sample; otherwise values stay null and the sample counts explain why the comparison is not displayed as zero.

object
key
required
Key
string
Allowed values: handoff_success handoff_timing fallback_rate booking_conversion voicemail_aging coverage_health emergency_override_duration
state
required
State
string
Allowed values: available insufficient_data unavailable
unit
required
Unit
string
Allowed values: basis_points seconds
current_value
Any of:
integer
previous_value
Any of:
integer
delta
Any of:
integer
current_sample_size
required
Current Sample Size
integer
previous_sample_size
required
Previous Sample Size
integer
detail_target
required
Detail Target
string
Allowed values: inbox activity override team integration
Example
{
  "days": 7,
  "cards": [
    {
      "key": "handoff_success",
      "state": "available",
      "unit": "basis_points",
      "detail_target": "inbox"
    }
  ]
}

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