Talkwalker Resources API
Resources
Resources are data retrieval settings from a Talkwalker project. This can be search-topics, filters, monitored-pages, source-panels, events, or saved-objects for embedding in external tools.
To get a list of the resources defined in a Talkwalker project use the project_id and the access_token on the endpoint.
Parameters
| parameter | description | required? | values |
|---|---|---|---|
| access_token | a read/write token specified in the API application | required | |
| type | filter on the type of resources | optional | search, filter, page, event, panel |
| option | only used with the value "include_empty_categories" to include empty topic/filter categories | optional | include_empty_categories |
Example: Get all saved objects from a project that were saved for embedding in an external tool called myapp.
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=sharedobject&object_type=myapp'
note
If no type is specified, all resources will be returned
Types
| Type | description |
|---|---|
| search | List of topic IDs and titles |
| filter | List of custom filter IDs and titles |
| page | List of channels and monitored pages |
| event | List of event IDs and titles |
| panel | List of panel IDs and titles |
| dataset | List of dataset IDs and titles in the Talkwalker Customer Intelligence project |
Credits
No credits for resources list.
Rate Limit
This endpoint is limited to 20 calls per minute, the result should be stored.
Examples
List of all topics of a project
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>?type=search'
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=search",
"result_resources": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project title>",
"topics": [
{
"id": "default",
"title": "",
"nodes": [
{
"id": "<topic ID 1>",
"title": "<topic title 1>"
},
{
"id": "<topic ID 2>",
"title": "<topic title 2>"
}
]
},
{
"id": "<topic Group ID 1>",
"title": "<topic Group title 1>",
"nodes": [
{
"id": "<topic ID 3>",
"title": "<topic title 3>"
}
]
}
]
}
]
}
}
note
Group ID default is the group "Ungrouped".
List of all channels and monitored pages of a project
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>?type=page'
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=page",
"result_resources": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project title>",
"channels": [
{
"id": "<Channel category ID>",
"title": "<Channel category title>",
"nodes": [
{
"id": "<channel ID 1>",
"title": "<www.example.com >"
}
]
}
]
}
]
}
}
List of all custom filters of a project
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>'
?type=filter'
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=filter",
"result_resources": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project title>",
"filters": [
{
"id": "<Filter category ID>",
"title": "<Filter category title>",
"nodes": [
{
"id": "<Filter ID>",
"title": "<Filter title>"
}
]
},
{
"id": "default_filter",
"title": ""
}
]
}
]
}
}
List of all events of a project
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>?type=event'
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=event",
"result_resources": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project title>",
"events": [
{
"id": "<Event ID>",
"title": "<Event title>"
}
]
}
]
}
}
List of all panels of a project
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>?type=event'
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/resources?access_token=<access_token>&type=panel",
"result_resources": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project title>",
"panels": [
{
"id": "favourites",
"title": ""
},
{
"id": "star1",
"title": ""
},
{
"id": "<Custom panel ID 1>",
"title": "<Custom panel title 1>"
}
]
}
]
}
}
Tags
To get a list of the tag IDs defined in a Talkwalker project use the project_id and the access_token on the endpoint.
Tag IDs can be used in the query syntax.
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/tags?access_token=<access_token>'
Parameters
| parameter | description | required? |
|---|---|---|
| access_token | a read/write token specified in the API application | required |
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/tags?access_token=<access_token>",
"result_tags": {
"tags": [
{
"label": "<Tags label 1>",
"id": "<Tags ID 1>"
},
{
"label": "<Tags label 2",
"id": "<Tags ID 2>"
}
]
}
}
NOTE: Tags labels supports hierarchy using /.
Rate Limit
This endpoint is limited to 40 calls per minute, the result should be stored.
Dashboards, reports and alerts
To get a list of the dashboard /report / alert IDs defined in a Talkwalker project, use the project_id and the access_token on the endpoint.
Command
curl 'https://api.talkwalker.com/api/v2/talkwalker/p/<project_id>/views?access_token=<access_token>'
Parameters
| parameter | description | required? |
|---|---|---|
| access_token | a read/write token specified in the API application | required |
Response
{
"status_code": "0",
"status_message": "OK",
"request": "GET /api/v2/talkwalker/p/<project_id>/views?access_token=<access_token>",
"result_views": {
"projects": [
{
"id": "<Project ID>",
"title": "<Project Title>",
"dashboards": [
{
"id": "<Dashboard ID>",
"title": "<Dashboard title>",
"last_update": 1626941639367
}
],
"reports": [
{
"id": "<Report ID 1>",
"title": "<Report title 1>",
"last_update": 1628585633695
},
{
"id": "<Alert ID 1>",
"title": "<Alert title 1>",
"last_update": 1628585747167
}
]
}
]
}
}
note
Alert and reports are under the array reports.
Rate Limit
This endpoint is limited to 20 calls per minute, the result should be stored.