cURL
curl --request GET \ --url https://api.example.com/api/realtime/messages/stats \ --header 'Authorization: Bearer <token>'
{ "totalMessages": 1250, "whDeliveryRate": 0.98, "topEvents": [ { "eventName": "order.created", "count": 450 }, { "eventName": "order.updated", "count": 380 }, { "eventName": "order.completed", "count": 220 } ] }
Retrieve aggregated statistics about messages
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Filter stats by channel ID
Filter stats since this timestamp
Message statistics
Total number of messages
x >= 0
1250
Webhook delivery success rate (0-1)
0 <= x <= 1
0.98
Most frequent event types
Show child attributes
Name of the event
"order.created"
Number of occurrences
450