Skip to main content
GET
Messaging cost analytics with time-series and channel breakdown

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).

group_by
enum<string>
default:day

Time-series bucket granularity.

Available options:
hour,
day,
week,
month

Response

200 - application/json

Cost totals, per-currency split, time-series and per-channel breakdown for the window.

data
object
meta
object