Skip to content
SIP.IO
DocsStart free

Live Supervisor Wallboard

The wallboard is a real-time, big-screen view of the contact center for supervisors: rolling KPI gauges, a tile per queue, and a live grid of every agent. It pairs the durable reporting metrics with the PresenceEngine’s live state so the numbers move the instant something happens.

The wallboard runs on the realtime service (realtime.sip.io). Two complementary feeds drive it:

  • /wallboard/ws: a WebSocket carrying the live snapshot, pushed on every agent/queue state change. This drives the queue tiles and agent grid in real time.
  • /wallboard/data: the rolling KPIs plus the current snapshot, polled every 15 seconds to refresh the gauges.

/wallboard itself serves the rendered HTML page that connects to both.

KPI gauges (account-wide, color-coded by threshold):

GaugeSource
Occupancy %mean agent occupancy
Service level %service level, weighted by offered
ASAaverage speed of answer, weighted by offered
AHTaverage handle time, weighted by answered
Abandon %abandon rate, weighted by offered

Queue tiles: one per queue, from the live snapshot, showing waiting callers, longest current wait, plus the queue’s service level and abandon rate. A tile turns red when the longest wait exceeds 120s or service level drops below 60%.

Agent grid: one cell per agent showing their live status bucket (ready, incall, ring, wrapup, paused, idle, extcall, offline, unreachable), color-coded, with a wrap-up countdown when an agent is in wrap. A legend tallies how many agents are in each bucket.

Because the grid and tiles are fed by the same delta stream as every other live consumer, they reflect reality with no polling lag.

/wallboard/data uses the standard API auth with the wallboard scope. Browsers can’t set headers on a WebSocket handshake, so the socket is authed with a short-lived single-use ticket: a scoped POST /wallboard/ticket mints a ticket, and the client connects to /wallboard/ws?ticket=… (the ticket is burned on use).

The WebSocket feed above is the recommended way to drive a live screen, but not every consumer wants a persistent socket. Three read-only REST endpoints under the reports scope give the same live picture as a point-in-time snapshot, polled on demand instead of pushed:

EndpointReturns
GET /v1/live/queuesPer-queue health: waiting count, longest wait, SLA-at-risk flag, active alerts.
GET /v1/live/agentsPer-agent time-in-current-state and, if paused, the pause reason.
GET /v1/live/interactionsA feed of in-progress interactions (calls in queue or in-flight).
Terminal window
curl 'https://api.sip.io/v1/live/queues' -H 'x-api-key: sk_…'
{
"queues": [
{ "queue": "q_support", "waiting": 3, "longestWaitMs": 42000, "slaAtRisk": true, "alerts": ["longest_wait"] }
]
}

These are additive alongside /wallboard/ws and /wallboard/data, not a replacement: use the WebSocket feed for a live-rendered screen, and the /v1/live/* endpoints when you want a snapshot on your own polling cadence (e.g. embedding a queue-health widget in another app) without holding a socket open. For rollup history beyond the current live state, see Queue Metrics & CDR and Agent KPIs.

A wall-mounted TV shouldn’t hold an API key. Wallboards (/v1/wallboards) let you design a board once and publish it to a link that any screen can open:

{
"name": "Support floor", "hash": "q3V9mW2k…(32 letters and digits)",
"timezone": "America/New_York", "rtl": false, "active": true,
"time_shifts": [480, 960],
"allowed_ips": ["203.0.113.0/24"],
"layout_config": { "theme": "dark", "widgets": [ … ] }
}
FieldPurpose
hashThe board’s public handle. The TV opens /v1/wallboards/public/{hash}, and the hash is the credential, so treat it like a password.
activeOnly a published board answers on its public link.
allowed_ipsOptionally lock the board to your office’s addresses.
time_shiftsShift start times (minutes after midnight, in the board’s timezone); counters on the board reset at each one, so “calls today” means “calls this shift”.
rtlRight-to-left layout (Hebrew, Arabic).
layout_configThe editor’s layout: theme, logo, widget grid.

The public link carries aggregate data only: queue and agent names, counters since the shift began, and a live feed with no caller numbers in it. An unknown hash, an unpublished board and a disallowed address all return the same 404, so the link can’t be probed. Saving a board pushes the change to every screen showing it.