Skip to main content


The following table shows parameters common to all endpoints that will be used in the Talkwalker Streaming API documentation.

Common parameters of endpoints
parameterdescriptionrequired?default value
access_tokena read/write token specified in the API applicationrequired
prettyreceive a prettified JSON response if set to trueoptionalfalse


Stream IDs, rule IDs, collector IDs, etc used in these endpoints can only contain lowercase letters, numbers and the characters - and _. They have to start with a lower case letter.

There are three types of chunks in the response of a request:

  • CT_RESULT (containing the result)
  • CT_CONTROL (containing information about the connection and possible information about the next result chunk)
  • CT_ERROR (for a possible error message).