Talkwalker Search API and Talkwalker Projects
https://api.talkwalker.com/api/v1/search/p/<project_id>/results?access_token=<access_token>
How it works
Talkwalker users can use the topics defined in their project with the Talkwalker API.
Topics can be used with the Search Results API by setting the parameter topic to one or more topic-IDs.
This allows Talkwalker users to use the queries from their projects and to retrieve the documents they get in their Talkwalker project including changes and tags that were done in Talkwalker.
In addition to the 30 days of search, the full history of Talkwalker projects is available in the search API, when used in combination with a Talkwalker project.
Talkwalker users can also retrieve the datasets defined in their Customer Intelligence project (also called VoC project) using the parameter dataset. A dataset is a set of documents disjoined from topic or channel documents, and have been imported following a customized data format. Datasets older than 7 days can no longer be queried.
Parameter
Same as Search API parameters with additional parameters topic, filter, channel, panel and dataset:
| parameter | description | required? | default value |
|---|---|---|---|
| access_token | API access token | required | |
| q | The query to search for | required | |
| offset | Number of results to skip (for paging) | optional | default: 0 / maximum: see below this table |
| hpp | Number of hits per page (for paging) | optional | default: 10 / maximum: 500 |
| sort_by | Criteria for sorting the results. | optional | default: engagement |
| sort_order | Sorting order (ascending or descending) | optional | default: desc |
| hl | Turns highlighting on or off | optional | default: true |
| pretty | Formatted json for testing | optional | false |
| time_range | Time range filter in the format number + a time unit character (e.g. 30d for 30 days.) | optional | |
| topic | One or more topics that are defined in the Talkwalker project | optional, multiple | |
| filter | One or more filters that are defined in the Talkwalker project | optional, multiple | |
| channel | One or more channels that are defined in the Talkwalker project | optional, multiple | |
| panel | One or more source panels that are defined in the Talkwalker project | optional, multiple | |
| dataset | One or more datasets that are defined in the Talkwalker Customer Intelligence project | optional, multiple |
The maximum offset value is influenced by the hits per page. hpp + offset can't be greater than 10.000.
Possible values for time_range as time unit characters are: s for seconds, m for minutes, h for hours, d for days, w for weeks and M for months.
Credits
1 credit per returned result, minimum 10 credits per Search Result API call.
Rate Limit
Project based search is limited to 60 calls per minute.
Limit the results by topic
In order to only include results that match either topic_a or topic_b when calling the search endpoint, we can add these topics as parameters.
https://api.talkwalker.com/api/v1/search/p/<project_id>/results?access_token=<access_token>&topic=topic_a&topic=topic_b
Get a list of all projects linked to an API application
Use the private access_token from your API application on the \https://api.talkwalker.com/api/v1/search/info endpoint to get the list of all linked projects.
More on Talkwalker Resources API to retrieve the resources configured in a project.
curl 'https://api.talkwalker.com/api/v1/search/info?access_token=<access_token>'
Parameters to list all projects
| parameter | description | required? | default value |
|---|---|---|---|
| access_token | a read/write token specified in the API application | required |
Credits
No credits for project list, resources list.
Rate Limit
This endpoint is limited to 10 calls per minute, the result should be stored.