Skip to main content
GET
/
api
/
messaging
/
analytics
/
overview
Analytics Overview
curl --request GET \
  --url https://api.example.com/api/messaging/analytics/overview/
{
  "period": {
    "start": "2025-11-01T00:00:00Z",
    "end": "2025-11-27T23:59:59Z"
  },
  "overview": {
    "total_messages": 10000,
    "delivered": 9500,
    "failed": 500,
    "delivery_rate": 95.0,
    "total_cost": 500.00,
    "average_cost_per_message": 0.05
  },
  "by_status": {
    "sent": 10000,
    "delivered": 9500,
    "failed": 500
  },
  "by_day": [
    {
      "date": "2025-11-01",
      "sent": 500,
      "delivered": 475,
      "failed": 25
    }
  ]
}
Get comprehensive analytics overview for a date range.
​
start_date
date
Start date (YYYY-MM-DD)
​
end_date
date
End date (YYYY-MM-DD)
Requires authentication. Include the access token in the Authorization header.

​
Success Response (200)

​
period
object
Period object with start and end dates
​
overview
object
Overview statistics
​
overview.total_messages
integer
Total messages in the period
​
overview.delivered
integer
Total delivered messages
​
overview.failed
integer
Total failed messages
​
overview.delivery_rate
float
Delivery rate percentage
​
overview.total_cost
float
Total cost
​
overview.average_cost_per_message
float
Average cost per message
​
by_status
object
Breakdown by status
​
by_day
array
Daily breakdown array
{
  "period": {
    "start": "2025-11-01T00:00:00Z",
    "end": "2025-11-27T23:59:59Z"
  },
  "overview": {
    "total_messages": 10000,
    "delivered": 9500,
    "failed": 500,
    "delivery_rate": 95.0,
    "total_cost": 500.00,
    "average_cost_per_message": 0.05
  },
  "by_status": {
    "sent": 10000,
    "delivered": 9500,
    "failed": 500
  },
  "by_day": [
    {
      "date": "2025-11-01",
      "sent": 500,
      "delivered": 475,
      "failed": 25
    }
  ]
}