Skip to main content
Server path: /talkwalker-streaming | Type: Application | PCID required: Yes

Tools

ToolDescription
talkwalker_streaming_create_project_stream_resultsListen on a specific project - POST method
talkwalker_streaming_create_stream_resultsListen a stream - POST method
talkwalker_streaming_delete_collectorDelete a collector
talkwalker_streaming_delete_export_taskAbort a task
talkwalker_streaming_delete_streamDelete a stream
talkwalker_streaming_export_project_streamCreate a new export taks on a specific project
talkwalker_streaming_export_streamCreate a new export task
talkwalker_streaming_export_stream_by_idCreate a new export task based on a stream definition
talkwalker_streaming_get_collectorGet collector definition
talkwalker_streaming_get_collector_resultsRead a collector
talkwalker_streaming_get_export_taskRetrieve status of the task
talkwalker_streaming_get_project_stream_resultsListen on a specific project
talkwalker_streaming_get_streamGet stream definition
talkwalker_streaming_get_stream_infoList of streams and collectors
talkwalker_streaming_get_stream_resultsListen a stream
talkwalker_streaming_list_export_tasksRetrieve all recent tasks status
talkwalker_streaming_pause_collectorPause a collector
talkwalker_streaming_resume_collectorResume a collector
talkwalker_streaming_update_collectorCreate or replace a collector
talkwalker_streaming_update_streamCreate or replace a stream

talkwalker_streaming_create_project_stream_results

Listen on a specific project - POST method Parameters:
ParameterTypeRequiredDefaultDescription
max_hitsintegerNoMax Hits
topicstringNoOne or more topics or panels that are defined in the Talkwalker project.
datasetstringNoOne or more datasets that are defined in the Talkwalker Customer Intelligence project.
filterstringNoOne or more custom filters that are defined in the Talkwalker project. The combination logic is the operator AND between the IDs if they are from different groups.
panelstringNoOne or more source panels that are defined in the Talkwalker project.
project_idstringYesProject Id
bodyobjectNoRequest body

talkwalker_streaming_create_stream_results

Listen a stream - POST method Parameters:
ParameterTypeRequiredDefaultDescription
max_hitsintegerNoMax Hits
stream_idstringYesStream Id
bodyobjectNoRequest body

talkwalker_streaming_delete_collector

Delete a collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector Id

talkwalker_streaming_delete_export_task

Abort a task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id

talkwalker_streaming_delete_stream

Delete a stream Parameters:
ParameterTypeRequiredDefaultDescription
stream_idstringYesStream Id

talkwalker_streaming_export_project_stream

Create a new export taks on a specific project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
bodyobjectNoRequest body

talkwalker_streaming_export_stream

Create a new export task Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoRequest body

talkwalker_streaming_export_stream_by_id

Create a new export task based on a stream definition Parameters:
ParameterTypeRequiredDefaultDescription
stream_idstringYesStream Id
bodyobjectNoRequest body

talkwalker_streaming_get_collector

Get collector definition Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector Id

talkwalker_streaming_get_collector_results

Read a collector Parameters:
ParameterTypeRequiredDefaultDescription
resume_offsetstringNoposition to resume the data access from. Can be retrieved from control chunks. Allowed values: earliest, latest or the resume_token from control_chunk. Default value: earliest
end_behaviourstringNowhat to do when we reached the most recent result. Allowed values: stop or wait. Default value: wait.
collector_idstringYesCollector Id

talkwalker_streaming_get_export_task

Retrieve status of the task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id

talkwalker_streaming_get_project_stream_results

Listen on a specific project Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoThe query to search for
max_hitsintegerNoStops the stream after the given number of hits. If not set, it never stops.
topicstringNoOne or more topics or panels that are defined in the Talkwalker project.
datasetstringNoOne or more datasets that are defined in the Talkwalker Customer Intelligence project.
filterstringNoOne or more custom filters that are defined in the Talkwalker project. The combination logic is the operator AND between the IDs if they are from different groups.
panelstringNoOne or more source panels that are defined in the Talkwalker project.
project_idstringYesProject Id

talkwalker_streaming_get_stream

Get stream definition Parameters:
ParameterTypeRequiredDefaultDescription
stream_idstringYesStream Id

talkwalker_streaming_get_stream_info

List of streams and collectors

talkwalker_streaming_get_stream_results

Listen a stream Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoThe query to search for
max_hitsintegerNoStops the stream after the given number of hits. If not set, it never stops.
stream_idstringYesStream Id

talkwalker_streaming_list_export_tasks

Retrieve all recent tasks status

talkwalker_streaming_pause_collector

Pause a collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector Id

talkwalker_streaming_resume_collector

Resume a collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector Id

talkwalker_streaming_update_collector

Create or replace a collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector Id
bodyobjectNoRequest body

talkwalker_streaming_update_stream

Create or replace a stream Parameters:
ParameterTypeRequiredDefaultDescription
stream_idstringYesStream Id
bodyobjectNoRequest body