Skip to main content
GET
/
api
/
messaging
/
dashboard
/
overview
Dashboard Overview
curl --request GET \
  --url https://api.example.com/api/messaging/dashboard/overview/
{
  "stats": {
    "total_contacts": 1500,
    "total_campaigns": 25,
    "total_messages_sent": 10000,
    "total_messages_delivered": 9500,
    "delivery_rate": 95.0,
    "total_spent": 500.00,
    "current_balance": 1000.00
  },
  "recent_activity": [
    {
      "type": "campaign_completed",
      "message": "Holiday Promotion campaign completed",
      "timestamp": "2025-11-27T10:30:00Z"
    }
  ]
}
Get dashboard overview statistics and recent activity.
Requires authentication. Include the access token in the Authorization header.

​
Success Response (200)

​
stats
object
Dashboard statistics object
​
stats.total_contacts
integer
Total number of contacts
​
stats.total_campaigns
integer
Total number of campaigns
​
stats.total_messages_sent
integer
Total messages sent
​
stats.total_messages_delivered
integer
Total messages delivered
​
stats.delivery_rate
float
Delivery rate percentage
​
stats.total_spent
float
Total amount spent
​
stats.current_balance
float
Current SMS balance
​
recent_activity
array
Array of recent activity items
{
  "stats": {
    "total_contacts": 1500,
    "total_campaigns": 25,
    "total_messages_sent": 10000,
    "total_messages_delivered": 9500,
    "delivery_rate": 95.0,
    "total_spent": 500.00,
    "current_balance": 1000.00
  },
  "recent_activity": [
    {
      "type": "campaign_completed",
      "message": "Holiday Promotion campaign completed",
      "timestamp": "2025-11-27T10:30:00Z"
    }
  ]
}