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

Developing

GET

/api/sms/analytics/delivery-status

Breakdown of messages by delivery state for a date range. Query params: from, to
(optional; default 30 days).

Success — 200 OK

{
  "success": true,
  "message": "Delivery status distribution fetched successfully",
  "data": {
    "total": 1280,
    "delivered": { "count": 1190, "percentage": 92.97 },
    "pending":   { "count": 65,   "percentage": 5.08 },
    "failed":    { "count": 25,   "percentage": 1.95 }
  }
}

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/delivery-status?from=undefined&to=undefined' \
--header 'x-api-key: {{x-api-key}}'

Response Example

{
  "success": true,
  "message": "Delivery status distribution fetched successfully",
  "data": {
    "total": 1280,
    "delivered": { "count": 1190, "percentage": 92.97 },
    "pending":   { "count": 65,   "percentage": 5.08 },
    "failed":    { "count": 25,   "percentage": 1.95 }
  }
}

Modified at 2026-06-23 09:42:16

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

Delivery report - /api/sms/analytics/delivery-report