Skip to main content
GET
Analytics summary for the window

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Query Parameters

days
integer

Trailing window in days (default 30, capped at 365). An explicit start_date / end_date pair takes precedence over days.

Required range: 1 <= x <= 365
start_date
string

Window start date in YYYY-MM-DD local tenant time. Must be used together with end_date.

end_date
string

Window end date in YYYY-MM-DD local tenant time. Must be used together with start_date.

Response

Summary in datatotal_messages, total_sent, total_delivered, total_terminal, total_failed, total_failed_deliveries, total_contacts, total_spend, and delivery_rate — within the standard { data, meta } envelope.

Summary in datatotal_messages, total_sent, total_delivered, total_terminal, total_failed, total_failed_deliveries, total_contacts, total_spend, and delivery_rate — within the standard { data, meta } envelope.