Skip to main content
GET
Aggregate message delivery metrics with time-series

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

start_date
string<date>

Inclusive start of the reporting window (ISO-8601 date or datetime). Defaults to the last 30 days when omitted; the range may not exceed the platform lookback cap.

end_date
string<date>

Inclusive end of the reporting window (ISO-8601 date or datetime). A single-day range (start_date === end_date) is accepted.

days
integer

Alternative rolling lookback in whole days (bounded by the lookback cap). Mutually exclusive with an explicit start/end range.

Required range: x >= 1
channel
string

Optional single-channel filter (e.g. sms, whatsapp, email, rcs, viber, telegram).

status
string

Optional message-status filter (e.g. delivered, failed).

campaign_id
string

Optional filter to a single campaign's messages.

group_by
enum<string>
default:day

Time-series bucket granularity.

Available options:
hour,
day,
week,
month
phone_number_id
string

Optional WhatsApp multi-WABA scope — narrows the time-series to outbound rows stamped with this sending phone_number_id.

Response

200 - application/json

Aggregate delivery totals plus the bucketed time-series for the window.

data
object
meta
object