Sign in

v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Messages

Get Message Statistics

Retrieve aggregated statistics about messages

get/api/realtime/messages/stats

Query parameters

channelIdstring uuid

Filter stats by channel ID

sincestring date-time

Filter stats since this timestamp

Response

Message statistics

totalMessagesinteger required

Total number of messages

whDeliveryRatenumber required

Webhook delivery success rate (0-1)

retentionDaysinteger nullable required

Number of days messages are retained. Null means messages are kept indefinitely.

Example response

{
  "totalMessages": 1250,
  "whDeliveryRate": 0.98,
  "topEvents": [
    {
      "eventName": "order.created",
      "count": 450
    }
  ]
}