Overview /api/sms/analytics/overview

Developing

GET

/api/sms/analytics/overview

High-level KPIs for a date range. Query params: from, to (optional; default 30 days).

Success — 200 OK

{
  "success": true,
  "message": "Analytics overview fetched successfully",
  "data": {
    "messages_sent": 1280,
    "delivery_rate": 92.97,
    "total_cost_today": "1,024.00",
    "response_rate": null,
    "campaign_data": {
      "total_campaigns": 14,
      "active_campaigns": 2,
      "total_amount_spent": "48,200.00"
    }
  }
}

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

Response Example

{
  "success": true,
  "message": "Analytics overview fetched successfully",
  "data": {
    "messages_sent": 1280,
    "delivery_rate": 92.97,
    "total_cost_today": "1,024.00",
    "response_rate": null,
    "campaign_data": {
      "total_campaigns": 14,
      "active_campaigns": 2,
      "total_amount_spent": "48,200.00"
    }
  }
}

Modified at 2026-06-23 10:06:02

Export logs (CSV) /api/sms/export

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