Skip to main content

index/interfaces/EngagementStatsUpdatedEvent.md

Emitted after the chat flush job processes messages for a stream. Contains updated engagement stats (chat + comment counts). Broadcast to token room every ~15 seconds when chat activity occurs.

Since​

8.5.0

Properties​

PropertyTypeDescription
chatobjectChat statistics (live stream messages - scoped to current/last stream session)
chat.messageCountnumberTotal number of chat messages
chat.sincestring | nullISO 8601 timestamp indicating the start of the counting period
chat.uniqueChattersnumberNumber of unique users who sent chat messages
commentsobjectComment statistics (token page comments - all-time)
comments.countnumberTotal number of token page comments
comments.uniqueCommentersnumberNumber of unique users who left comments
tokenNamestringToken name for which engagement stats were updated