Skip to main content
GET
/
api
/
realtime
/
messages
/
stats
Get Message Statistics
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
    }
  ],
  "retentionDays": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
channelId
string<uuid>

Filter stats by channel ID

​
since
string<date-time>

Filter stats since this timestamp

Response

Message statistics

​
totalMessages
integer
required

Total number of messages

Required range: x >= 0
Example:

1250

​
whDeliveryRate
number
required

Webhook delivery success rate (0-1)

Required range: 0 <= x <= 1
Example:

0.98

​
topEvents
object[]
required

Most frequent event types

​
retentionDays
integer | null
required

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

Required range: x >= 1
Example:

null