Delivery report - /api/sms/analytics/delivery-report
Developing
GET
/api/sms/analytics/delivery-report
year(optional, e.g.
2026; defaults to the current year).200 OK{
"success": true,
"message": "Delivery report fetched successfully",
"data": {
"summary": {
"successfully_delivered": 14820,
"pending_delivery": 320,
"failed_rejected": 410
},
"monthly_trend": [
{ "month": "January", "total": 1200, "delivered": 1150, "failed": 30, "sent_pending": 20, "delivery_rate": 95.83 },
{ "month": "February", "total": 1100, "delivered": 1060, "failed": 25, "sent_pending": 15, "delivery_rate": 96.36 }
]
}
}summary is all-time; monthly_trend covers the requested year. delivery_rate is a percentage.Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.com/api/sms/analytics/delivery-report?year=undefined' \
--header 'x-api-key: {{x-api-key}}'Response Response Example
{
"success": true,
"message": "Delivery report fetched successfully",
"data": {
"summary": {
"successfully_delivered": 14820,
"pending_delivery": 320,
"failed_rejected": 410
},
"monthly_trend": [
{ "month": "January", "total": 1200, "delivered": 1150, "failed": 30, "sent_pending": 20, "delivery_rate": 95.83 },
{ "month": "February", "total": 1100, "delivered": 1060, "failed": 25, "sent_pending": 15, "delivery_rate": 96.36 }
]
}
}Modified at 2026-06-23 09:42:39