Event Chat History

Chat history for an event

Info

Required scopes: chat.read

Warning

This method requires authentication

Retrieve a paginated list of chat messages for a specific event, ordered chronologically and aggregated across every connected platform.

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

Path Parameters:

ParameterTypeDescription
eventIdstring (UUID)The UUID of the event (required)

Query Parameters:

ParameterTypeDescription
pageSizeintegerNumber of messages to return, from 1 to 1000 (optional)
pageTokenstringOpaque cursor from a previous response's nextPageToken or previousPageToken (optional)
timestampintegerUnix epoch seconds to seek to. Mutually exclusive with pageToken (optional)

Use pageToken to page through results, or timestamp to jump to a point in time — do not send both in the same request.

Example request:

curl -H "Authorization: Bearer [access token]" \
     "https://api.restream.io/v2/user/events/{eventId}/chat/history?pageSize=100&pageToken=[token]"

Response

Success
Error
{
  "messages": [
    {
      "timestamp": "2024-07-13T14:35:00Z",
      "platform": "YouTube",
      "channelName": "channel-name",
      "author": "author-name",
      "text": "message text",
      "meta": null
    }
  ],
  "nextPageToken": "token-or-null",
  "previousPageToken": "token-or-null"
}
Info

platform, channelName, text, and meta may be null. nextPageToken and previousPageToken are null at the ends of the range.