Discussion's historical mentions export stream

Tier: Enterprise

Rate limit: 14400 requests per hour, 2 concurrent connections

Data limitations:

  • Mentions cap - monthly limit applies

Discussion: A discussion represents a collection of mentions within a single thread that share the same discussion.id value. For example, a Facebook post along with all its comments forms one discussion.

⚠️ 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.

Long-running stream of discussion mentions matching filters and sorting criteria. Best for bulk extraction of huge volumes of data from a specific discussion thread. Multiple different filters such as time-range, sentiment, source can be applied. 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…
Path Params
string
required

The ID of the discussion thread to stream mentions from (must match mention's field discussion.id)

Query Params
string
enum

⚠️ Experimental - this parameter is in experimental phase and may be changed in a future version without being considered a breaking change.

Enables anonymization of personal data fields on returned mentions, allowing you to process mention data without exposing personally identifiable information — useful for compliance and data privacy requirements.

Anonymized field values are replaced with a consistent hash, so the same original value always produces the same hash across all mentions.

Available levels:

  • author - anonymizes author-related fields:
    • author.id, author.name - replaced with a consistent hash
    • author.avatar - set to null
    • discussion.author.name - replaced with a consistent hash
  • all - anonymizes all identification-related fields:
    • author.id, author.name - replaced with a consistent hash
    • author.avatar - set to null
    • discussion.author.name - replaced with a consistent hash
    • source.socialChannel.id, source.socialChannel.name - replaced with a consistent hash
    • location - removed entirely
Allowed:
Body Params

Search request with filters and sorting options

Request model for searching mentions with optional filters and sorting. If sortType is omitted, defaults to PublishedAtDescending.

filters
object

Filters to apply to ordered searches. If omitted in Recent mentions search, publishedAt defaults to the last 7 days.

string
enum

Defines how to sort search results (Default is PublishedAtDescending)

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