Engagement updates live stream (firehose)

Tier: Enterprise

Rate limit: 3600 requests per hour, 1 concurrent connection

Data limitations:

  • Engagement updates for mentions published within last month (rolling time-window), collected by the system since connection start (with optional 5-minute backfill)

⚠️ WARNING: Due to limitations of readme.com API console, the Try it out button will not work for streaming endpoints. Please copy the generated curl command and execute it in your terminal to test streaming functionality.

⚠️ WARNING: The order of engagement updates in the live stream is random and you cannot make any assumptions about it. Updates arrive as they are collected from various sources.

Infinite live-stream of engagement metric updates (likes, shares, comments counts, etc.) for mentions published within last month (rolling time-window) which are being collected by SentiOne system from the moment the stream connection starts.

This endpoint provides real-time updates about engagement metrics changes on mentions. Each event contains the mention ID, updated engagement metrics, and the timestamp of the update.

Supports optional backfill of recent engagement updates. Supports both SSE (Server-Sent Events) and NDJSON (Newline Delimited JSON) formats.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
0 to 5
Defaults to 0

Number of minutes to backfill (0-5 minutes maximum)

Headers
string
enum
required

Stream format - 'text/event-stream' for SSE or 'application/x-ndjson' for newline-delimited JSON

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream
application/x-ndjson
application/json