Skip to main content

Get campaign statistics

GET 
/api/partner-gateway/v1/campaigns/stats

Returns aggregated delivery statistics for campaigns in a given date range. Results are grouped by the aggregateOn time bucket. Valid values for aggregateOn are: hour, day, week, and month. You must provide both startDate and endDate in yyyy-MM-dd format to define the reporting window. Filter by sendingMode (SMS, RCS, WHATSAPP) to see statistics for a specific channel, or omit it to get combined stats across all channels. Set isDraft=false to exclude draft campaigns that were never sent, so that only confirmed and dispatched campaigns contribute to the statistics. Each time bucket in the response contains counts for total messages sent, delivered, failed, and other delivery metrics. Results are paginated: use page (0-based) and limit to control pagination, and direction=ASC or direction=DESC to sort the time buckets chronologically or in reverse. This endpoint is useful for building analytics dashboards, generating periodic delivery reports, and monitoring campaign performance trends over time. Returns 401 if the API key is missing or invalid.

Request​

Responses​

Statistics retrieved successfully

Last updated on