Message volume /api/sms/analytics/message-volume

Developing

GET

/api/sms/analytics/message-volume

Message counts bucketed over time (combines direct messages and campaigns).

Query params: from, to (optional; default 30 days), group_by = day (default) or month.

Success — 200 OK — an array, oldest bucket first:

{
  "success": true,
  "message": "Message volume fetched successfully",
  "data": [
    { "date": "2026-06-20", "total": 120, "delivered": 110, "failed": 5, "pending": 5 },
    { "date": "2026-06-21", "total": 98,  "delivered": 95,  "failed": 1, "pending": 2 }
  ]
}

date is YYYY-MM-DD when group_by=day, YYYY-MM when group_by=month. Buckets are
in your timezone (default WAT).

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://prod.your-api-server.com/api/sms/analytics/message-volume?from=undefined&to=undefined&group_by=day' \
--header 'x-api-key: {{x-api-key}}'

Response Example

{
  "success": true,
  "message": "Message volume fetched successfully",
  "data": [
    { "date": "2026-06-20", "total": 120, "delivered": 110, "failed": 5, "pending": 5 },
    { "date": "2026-06-21", "total": 98,  "delivered": 95,  "failed": 1, "pending": 2 }
  ]
}

Modified at 2026-06-23 09:41:49

Overview /api/sms/analytics/overview

Delivery status distribution /api/sms/analytics/delivery-status