Live Stream Analytics - Chat Messages

Get chat message analytics for an event

Retrieve chat message analytics for a specific event, both as a combined total and broken down per channel.

• total — aggregated chat metrics across all channels for the event.
• byChannel — the same metrics keyed by channel id, with one entry per channel the event streamed to.

Each section reports:

• messagesTotal — total number of chat messages.
• chattersTotal — total number of unique chatters.
• messagesPerMinute — time series of message counts, one point per minute (timestamp in seconds).

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/events/{eventId}/analytics/messages

Path Parameters:

Response

{
  "total": {
    "messagesTotal": 1840,
    "chattersTotal": 312,
    "messagesPerMinute": [
      { "timestamp": 1599983310, "messages": 24 },
      { "timestamp": 1599983370, "messages": 31 }
    ]
  },
  "byChannel": {
    "123456": {
      "messagesTotal": 1120,
      "chattersTotal": 198,
      "messagesPerMinute": [
        { "timestamp": 1599983310, "messages": 15 },
        { "timestamp": 1599983370, "messages": 19 }
      ]
    }
  }
}

{
  "error": {
    "statusCode": 401,
    "status": 401,
    "code": 401,
    "message": "Invalid token: access token is invalid",
    "name": "invalid_token"
  }
}