Advanced message analytics
Full advanced-analytics payload for the window: daily volume, the delivery funnel, channel and geographic breakdown, peak hours (with the tenant timezone they’re computed in), cost by channel, and top recipients. Use ?days= (default 30, max 365) or an explicit start_date / end_date pair to select the window. Requires the advanced-analytics feature flag; otherwise returns 403.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
true, false Query Parameters
Trailing window in days (default 30, capped at 365). An explicit start_date / end_date pair takes precedence over days.
1 <= x <= 365Window start date in YYYY-MM-DD local tenant time. Must be used together with end_date.
Window end date in YYYY-MM-DD local tenant time. Must be used together with start_date.
Response
Analytics payload in data — daily_volume, delivery_funnel, channel_breakdown, geo_breakdown, peak_hours, peak_hours_timezone, cost_by_channel, and top_recipients — within the standard { data, meta } envelope.
Analytics payload in data — daily_volume, delivery_funnel, channel_breakdown, geo_breakdown, peak_hours, peak_hours_timezone, cost_by_channel, and top_recipients — within the standard { data, meta } envelope.