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

Tools

ToolDescription
talkwalker_search_get_credits_statusStatus credits
talkwalker_search_get_global_histogramHistogram from global index
talkwalker_search_get_global_search_resultsRetrieve documents from global index
talkwalker_search_get_global_summaryFetch summary from global index
talkwalker_search_get_project_histogramHistogram from a talkwalker project
talkwalker_search_get_project_listList of allowed projects
talkwalker_search_get_project_search_resultsRetrieve documents from a Talkwalker project
talkwalker_search_get_project_summaryFetch summary from a Talkwalker project
talkwalker_search_get_project_top_influencersHistogram Top influencers from a talkwalker project

talkwalker_search_get_credits_status

Status credits

talkwalker_search_get_global_histogram

Histogram from global index Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesThe query to search for.
minstringNoMinimum value for bins
maxstringNoMaximum value for bins
min_includestringNoInclude min value. Allowed values: true or false. Default value: true.
max_includestringNoInclude max value. Allowed values: true or false. Default value: false.
intervalstringNoBin Interval. Duration for published and search_indexed / Integer for histogram / not used for distribution.
timezonestringNoTimezone for the duration interval (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
breakdownstringNoNested histogram. Allowed values: sentiment, sourcetype, country.
value_typestringNoNested metric for time based histograms.
top_nintegerNoSize limiter for demographic distribution.
typestringYesThe type value

talkwalker_search_get_global_search_results

Retrieve documents from global index Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesThe query to search for.
timezonestringNoTimezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
time_rangestringNoTime range filter. Format number + a time unit character (e.g. 30d for 30 days.).
offsetintegerNoNumber of results to skip (for paging). Vaule is between 0 and 500. Default value: 0.
hppintegerNoNumber of hits per page (for paging). Allowed value is between 0 and 500. Default value: 10.
sort_bystringNoCriteria for sorting the results. Allowed values: engagement, published, reach, facebook_shares, facebook_likes, twitter_shares, twitter_retweets, twitter_followers, youtube_likes, youtube_dislikes, youtube_views, cluster_size, comment_count, published, search_indexed, trending_score. Default value is engagement.
sort_orderstringNoSorting order (ascending or descending). Allowed values: asc, desc Default value: desc.
hlbooleanNoTurns highlighting on or off. Allowed values: true or false. Default value: true.
prettybooleanNoFormatted json for testing. Allowed values: true or false. Default value: false.

talkwalker_search_get_global_summary

Fetch summary from global index Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesThe query to search for.
timezonestringNoTimezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
time_rangestringNoTime range filter. Format number + a time unit character (e.g. 30d for 30 days.).

talkwalker_search_get_project_histogram

Histogram from a talkwalker project Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoThe query to search for.
minstringNoMinimum value for bins
maxstringNoMaximum value for bins
min_includestringNoInclude min value. Allowed values: true or false. Default value: true.
max_includestringNoInclude max value. Allowed values: true or false. Default value: false.
intervalstringNoBin Interval. Duration for published and search_indexed / Integer for histogram / not used for distribution.
timezonestringNoTimezone for the duration interval (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
breakdownstringNoNested histogram. Allowed values: sentiment, sourcetype, country, topic, channel.
value_typestringNoNested metric for time based histograms.
top_nintegerNoSize limiter for demographic distribution.
forecast_daysintegerNoTime series forecast in days for enabled projects. Available for histogram types published and search_indexed Value: [1, 90]
project_idstringYesProject Id
typestringYesThe type value

talkwalker_search_get_project_list

List of allowed projects

talkwalker_search_get_project_search_results

Retrieve documents from a Talkwalker project Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoThe query to search for.
timezonestringNoTimezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
time_rangestringNoTime range filter. Format number + a time unit character (e.g. 30d for 30 days.).
offsetintegerNoNumber of results to skip (for paging). Vaule is between 0 and must respect the rule that hpp+offset is less than 10.000. Default value: 0.
hppintegerNoNumber of hits per page (for paging). Value is between 0 and 500. Default value: 10.
sort_bystringNoCriteria for sorting the results. Allowed values: engagement, published, reach, facebook_shares, facebook_likes, twitter_shares, twitter_retweets, twitter_followers, youtube_likes, youtube_dislikes, youtube_views, cluster_size, comment_count, published, search_indexed, trending_score. Default value: engagement.
sort_orderstringNoSorting order (ascending or descending). Default value is desc.
hlbooleanNoTurns highlighting on or off. Allowed values: true or false. Default value: true.
prettybooleanNoFormatted json for testing. Possible values are true or false. Default value: false.
topicstringNoOne or more topics that are defined in the Talkwalker project
filterstringNoOne or more filters that are defined in the Talkwalker project.
channelstringNoOne or more channels that are defined in the Talkwalker project.
panelstringNoOne or more source panels that are defined in the Talkwalker project.
datasetstringNoOne or more datasets ID that are defined in the Talkwalker Customer Intelligence project
project_idstringYesProject Id

talkwalker_search_get_project_summary

Fetch summary from a Talkwalker project Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoThe query to search for.
timezonestringNoTimezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC
time_rangestringNoTime range filter. Format number + a time unit character (e.g. 30d for 30 days.).
topicstringNoOne or more topics that are defined in the Talkwalker project
filterstringNoOne or more filters that are defined in the Talkwalker project.
channelstringNoOne or more channels that are defined in the Talkwalker project.
panelstringNoOne or more source panels that are defined in the Talkwalker project.
datasetstringNoOne or more datasets ID that are defined in the Talkwalker Customer Intelligence project
project_idstringYesProject Id

talkwalker_search_get_project_top_influencers

Histogram Top influencers from a talkwalker project Parameters:
ParameterTypeRequiredDefaultDescription
influencer_typestringNoGet the results for authors or sources. Allowed values: author or source. Default value is author.
sort_criteriastringNoSort the results (always descending) by a criteria. Allowed values : total, positive, negative, neutral, reach, engagement, engagement_per_mention, reach_per_mention. Default value : total
qstringNoThe query to search for.
top_nintegerNoSize limiter for demographic distribution. Allowed values : between 1 and 100. Default value : 10.
topicstringNoOne or more topics that are defined in the Talkwalker project
filterstringNoOne or more filters that are defined in the Talkwalker project
channelstringNoOne or more channels that are defined in the Talkwalker project
panelstringNoOne or more source panels that are defined in the Talkwalker project
datasetstringNoOne or more datasets that are defined in the Talkwalker Customer Intelligence project
project_idstringYesProject Id