Skip to Content

Analytics

Messaging analytics, channel stats, and data export. 6 endpoints under /v1/analytics.

Messaging analytics, channel stats, and data export. Namespace keys read only their own traffic; organization callers can narrow results with namespaceId. Every date range is half-open, after inclusive, before exclusive, and may span at most 366 days. Both bounds are absolute ISO-8601 instants carrying Z or a numeric offset; a bare calendar date is rejected, because reading it as UTC midnight would shift every bucket for an organization outside UTC. AnalyticsQueryError refuses a longer span and a before sent without an after, which bounds nothing. Omitting both bounds reports the organization's whole history. Calendar buckets follow the organization's timezone.

Endpoints

EndpointWhat it does
GET /v1/analytics/channel-statsGet channel performance analytics
GET /v1/analytics/delivery-metricsGet message delivery metrics
POST /v1/analytics/exportExport messaging analytics data
GET /v1/analytics/hourly-distributionGet hourly message distribution
GET /v1/analytics/statsGet message volume analytics
GET /v1/analytics/top-contactsList top contacts by message volume

Base URL, authentication, errors, and pagination are the same for every endpoint; see the REST API reference.

Related documentation

On this page