/talkwalker-search | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
talkwalker_search_get_credits_status | Status credits |
talkwalker_search_get_global_histogram | Histogram from global index |
talkwalker_search_get_global_search_results | Retrieve documents from global index |
talkwalker_search_get_global_summary | Fetch summary from global index |
talkwalker_search_get_project_histogram | Histogram from a talkwalker project |
talkwalker_search_get_project_list | List of allowed projects |
talkwalker_search_get_project_search_results | Retrieve documents from a Talkwalker project |
talkwalker_search_get_project_summary | Fetch summary from a Talkwalker project |
talkwalker_search_get_project_top_influencers | Histogram Top influencers from a talkwalker project |
talkwalker_search_get_credits_status
Status creditstalkwalker_search_get_global_histogram
Histogram from global index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | The query to search for. |
min | string | No | — | Minimum value for bins |
max | string | No | — | Maximum value for bins |
min_include | string | No | — | Include min value. Allowed values: true or false. Default value: true. |
max_include | string | No | — | Include max value. Allowed values: true or false. Default value: false. |
interval | string | No | — | Bin Interval. Duration for published and search_indexed / Integer for histogram / not used for distribution. |
timezone | string | No | — | Timezone for the duration interval (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
breakdown | string | No | — | Nested histogram. Allowed values: sentiment, sourcetype, country. |
value_type | string | No | — | Nested metric for time based histograms. |
top_n | integer | No | — | Size limiter for demographic distribution. |
type | string | Yes | — | The type value |
talkwalker_search_get_global_search_results
Retrieve documents from global index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | The query to search for. |
timezone | string | No | — | Timezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
time_range | string | No | — | Time range filter. Format number + a time unit character (e.g. 30d for 30 days.). |
offset | integer | No | — | Number of results to skip (for paging). Vaule is between 0 and 500. Default value: 0. |
hpp | integer | No | — | Number of hits per page (for paging). Allowed value is between 0 and 500. Default value: 10. |
sort_by | string | No | — | Criteria 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_order | string | No | — | Sorting order (ascending or descending). Allowed values: asc, desc Default value: desc. |
hl | boolean | No | — | Turns highlighting on or off. Allowed values: true or false. Default value: true. |
pretty | boolean | No | — | Formatted json for testing. Allowed values: true or false. Default value: false. |
talkwalker_search_get_global_summary
Fetch summary from global index Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | The query to search for. |
timezone | string | No | — | Timezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
time_range | string | No | — | Time 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | The query to search for. |
min | string | No | — | Minimum value for bins |
max | string | No | — | Maximum value for bins |
min_include | string | No | — | Include min value. Allowed values: true or false. Default value: true. |
max_include | string | No | — | Include max value. Allowed values: true or false. Default value: false. |
interval | string | No | — | Bin Interval. Duration for published and search_indexed / Integer for histogram / not used for distribution. |
timezone | string | No | — | Timezone for the duration interval (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
breakdown | string | No | — | Nested histogram. Allowed values: sentiment, sourcetype, country, topic, channel. |
value_type | string | No | — | Nested metric for time based histograms. |
top_n | integer | No | — | Size limiter for demographic distribution. |
forecast_days | integer | No | — | Time series forecast in days for enabled projects. Available for histogram types published and search_indexed Value: [1, 90] |
project_id | string | Yes | — | Project Id |
type | string | Yes | — | The type value |
talkwalker_search_get_project_list
List of allowed projectstalkwalker_search_get_project_search_results
Retrieve documents from a Talkwalker project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | The query to search for. |
timezone | string | No | — | Timezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
time_range | string | No | — | Time range filter. Format number + a time unit character (e.g. 30d for 30 days.). |
offset | integer | No | — | Number 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. |
hpp | integer | No | — | Number of hits per page (for paging). Value is between 0 and 500. Default value: 10. |
sort_by | string | No | — | Criteria 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_order | string | No | — | Sorting order (ascending or descending). Default value is desc. |
hl | boolean | No | — | Turns highlighting on or off. Allowed values: true or false. Default value: true. |
pretty | boolean | No | — | Formatted json for testing. Possible values are true or false. Default value: false. |
topic | string | No | — | One or more topics that are defined in the Talkwalker project |
filter | string | No | — | One or more filters that are defined in the Talkwalker project. |
channel | string | No | — | One or more channels that are defined in the Talkwalker project. |
panel | string | No | — | One or more source panels that are defined in the Talkwalker project. |
dataset | string | No | — | One or more datasets ID that are defined in the Talkwalker Customer Intelligence project |
project_id | string | Yes | — | Project Id |
talkwalker_search_get_project_summary
Fetch summary from a Talkwalker project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | The query to search for. |
timezone | string | No | — | Timezone for the time_range (e.g. Europe/Luxembourg). Allowed values are timezone names. Default value: UTC |
time_range | string | No | — | Time range filter. Format number + a time unit character (e.g. 30d for 30 days.). |
topic | string | No | — | One or more topics that are defined in the Talkwalker project |
filter | string | No | — | One or more filters that are defined in the Talkwalker project. |
channel | string | No | — | One or more channels that are defined in the Talkwalker project. |
panel | string | No | — | One or more source panels that are defined in the Talkwalker project. |
dataset | string | No | — | One or more datasets ID that are defined in the Talkwalker Customer Intelligence project |
project_id | string | Yes | — | Project Id |
talkwalker_search_get_project_top_influencers
Histogram Top influencers from a talkwalker project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
influencer_type | string | No | — | Get the results for authors or sources. Allowed values: author or source. Default value is author. |
sort_criteria | string | No | — | Sort the results (always descending) by a criteria. Allowed values : total, positive, negative, neutral, reach, engagement, engagement_per_mention, reach_per_mention. Default value : total |
q | string | No | — | The query to search for. |
top_n | integer | No | — | Size limiter for demographic distribution. Allowed values : between 1 and 100. Default value : 10. |
topic | string | No | — | One or more topics that are defined in the Talkwalker project |
filter | string | No | — | One or more filters that are defined in the Talkwalker project |
channel | string | No | — | One or more channels that are defined in the Talkwalker project |
panel | string | No | — | One or more source panels that are defined in the Talkwalker project |
dataset | string | No | — | One or more datasets that are defined in the Talkwalker Customer Intelligence project |
project_id | string | Yes | — | Project Id |

