Skip to main content
GET
Get Calls Summary

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Query Parameters

days
integer
default:7

The rolling window.

Required range: 1 <= x <= 90

Response

Call totals.

days
integer
required

The window asked for.

timezone
string
required

Your workspace's time zone, which buckets are in.

grain
enum<string>
required

hour when days is 1, else day.

Available options:
hour,
day
calls
integer
required

All calls.

inbound
integer
required

Inbound calls.

outbound
integer
required

Outbound calls.

answered
integer
required

Calls that connected.

missed
integer
required

Calls that never connected and were missed or completed unanswered.

failed
integer
required

Calls that never connected and failed.

seconds
integer
required

Total call seconds.

debitMicro
integer
required

What the calls cost you (a white-label client's at its reseller's price). Integer micro-units of currency: 1000000 is one rupee or one dollar.

surfaces
object
required

Calls by surface.

series
object[]
required

One bucket per hour or day, in your time zone.