Skip to content
Vocapable Developers

Read the compact customer-portal Home summary

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

Return bounded carrier activity, current work, outcomes, and attention states.

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 attempt and turn ledgers are month-partitioned, so a report must name both sides of its 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
DashboardSummary

GET /v1/dashboard-summary response for the portal Home screen.

object
window
required
DashboardWindow

The exact half-open UTC interval the historical counts cover.

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
as_of
required
As Of
string format: date-time
call_totals
required
DashboardCallTotals

Legacy ingress/attempt activity by creation time; not call-log counts.

object
inbound_calls
required
Inbound Calls
integer
outbound_dials
required
Outbound Dials
integer
call_records
required
DashboardCallRecords

Durable calls by direction whose started_at is inside the response window.

These match /v1/calls with direction and started_at >= start, < end filters. Calls persisted after a read can appear on a subsequent read of the same window.

object
inbound_calls
required
Inbound Calls
integer
outbound_calls
required
Outbound Calls
integer
browser_calls
required
Browser Calls
integer
agents
Agents
Array<object>
DashboardAgentHeadline

One configured agent’s compact health and activity headline.

object
id
required
Id
string
>= 1 characters <= 128 characters
name
required
Name
string
>= 1 characters <= 200 characters
use_case
required
Use Case
string
Allowed values: sdr staffing survey reminder custom receptionist recruiting
status
required
Status
string
Allowed values: draft active archived
health
required
Health
string
Allowed values: live setup_needed attention archived
latest_version
Any of:
integer
>= 1
calls
required
DashboardCallTotals

Legacy ingress/attempt activity by creation time; not call-log counts.

object
inbound_calls
required
Inbound Calls
integer
outbound_dials
required
Outbound Dials
integer
call_records
required
DashboardCallRecords

Durable calls by direction whose started_at is inside the response window.

These match /v1/calls with direction and started_at >= start, < end filters. Calls persisted after a read can appear on a subsequent read of the same window.

object
inbound_calls
required
Inbound Calls
integer
outbound_calls
required
Outbound Calls
integer
browser_calls
required
Browser Calls
integer
open_caller_work
required
DashboardOpenCallerWork

Current unresolved caller requests, regardless of when they were opened.

object
total
required
Total
integer
messages
required
Messages
integer
support_tickets
required
Support Tickets
integer
high_priority_tickets
required
High Priority Tickets
integer
outcomes
required
DashboardOutcomes

Durable business results created inside the requested historical window.

object
leads_captured
required
Leads Captured
integer
messages_taken
required
Messages Taken
integer
tickets_opened
required
Tickets Opened
integer
callbacks_scheduled
required
Callbacks Scheduled
integer
appointments_created
required
Appointments Created
integer
shifts_confirmed
required
Shifts Confirmed
integer
survey_responses
required
Survey Responses
integer
attention
Attention
Array<object>
DashboardAttention

A small server-derived work signal; zero means the item is ready.

object
key
required
Key
string
Allowed values: caller_work receptionist_health agent_setup
state
required
State
string
Allowed values: ready attention
count
required
Count
integer
Example
{
  "agents": [
    {
      "use_case": "sdr",
      "status": "draft",
      "health": "live"
    }
  ],
  "attention": [
    {
      "key": "caller_work",
      "state": "ready"
    }
  ]
}

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