Skip to main content
GET
Count calls

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Query Parameters

from
string
to
string

Response

This workspace

GET /v2/calls/summary: this workspace's calls created in [from, to), or all of them when both are null. Every key is always present; counts are calls, one per call id.

by_channel
object
required

Calls per channel: phone (dialled out, answered inbound, or WhatsApp), web (browser sessions), text (the console's typed test chat) and realtime (Realtime API sessions). The call object's channel says which one a call is.

by_direction
object
required

Calls per direction. Browser, text and realtime calls are outbound.

duration_secs
integer
required

The calls' duration_secs, summed. A call that never connected, or has not ended, adds 0.

Required range: x >= 0
from
string<date-time> | null
required

The from you sent (inclusive), in UTC; null when you sent none.

object
enum<string>
required
Available options:
call_summary
to
string<date-time> | null
required

The to you sent (exclusive), in UTC; null when you sent none.

total
integer
required

Every call in the window, whatever its status. by_channel and by_direction each add up to it.

Required range: x >= 0