Skip to main content
GET
Get WhatsApp 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. Ignored when from/to are given.

Required range: 1 <= x <= 90
from
string<date>

Range start, YYYY-MM-DD, your time zone. Needs to.

to
string<date>

Range end, YYYY-MM-DD, inclusive. Needs from.

Response

WhatsApp totals.

timezone
string
required

Your workspace's time zone.

grain
enum<string>
required

hour for a one-day window, else day.

Available options:
hour,
day
sent
integer
required

Messages sent by the agent or a person.

delivered
integer
required

Sent messages whose latest receipt is delivered (not yet read).

read
integer
required

Sent messages read.

failed
integer
required

Sent messages that failed.

noReceipt
integer
required

Sent messages with no receipt yet.

received
integer
required

Messages received from customers.

series
object[]
required
errors
object[]
required

Failures by WhatsApp error code, most first.

cost
object
required

What the window's WhatsApp messages cost you, priced as the WhatsApp dashboard prices them.

days
integer

The rolling window, when asked by days. Absent with from/to.

from
string<date>

Range start, when asked by from/to.

to
string<date>

Range end, when asked by from/to.