# Refined from the Talkwalker-published OpenAPI at # https://developer.talkwalker.com/talkwalker-api.yaml (harvested 2026-08-13) # Split by tag group; operations carried verbatim. Verbatim source: openapi/_original/talkwalker-openapi.yaml openapi: 3.0.0 info: title: Talkwalker Resources API description: Talkwalker Advanced API version: 0.0.1 contact: email: client-api@talkwalker.com name: Client-API externalDocs: description: Find more info here or there url: https://apidocs.talkwalker.com/ servers: - description: Production environment server url: https://api.talkwalker.com security: - apikeyAuth: [] tags: - name: Resources API - name: Source panels API - name: Topic API paths: /api/v2/talkwalker/p/{project_id}/resources: get: description: Retrieve a list of data retrieval settings from a Talkwalker project. parameters: - description: 'Filter on the type of resources. Allowed values: search, filter, page, event or panel.' example: search in: query name: type schema: type: string - example: a1ab1abc-a123-123a-123a-abcd12ab1a12 in: path name: project_id required: true schema: type: string responses: '200': content: application/json: example: request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/resources?type=search&access_token=abcd_1234_abcd request_id: '#r8w4jwr5idz3#' result_resources: projects: - id: a1ab1abc-a123-123a-123a-abcd12ab1a12 title: Pascal's Project topics: - id: default nodes: - description: '' id: kpnutesu_1234 title: Tesla - description: '' id: kpnzh6u5_1234 title: BMW title: '' status_code: '0' status_message: OK schema: type: object description: OK summary: List of resources tags: - Resources API /api/v2/talkwalker/p/{project_id}/source_panels/add: post: tags: - Source panels API summary: Create a new panel description: Create one or multiple source panels. Entries can be a source, an author or an URL. requestBody: content: application/json: schema: type: object example: panels: - title: API Panel demo description: test by API included_entries: - entry_type: URL url: www.testme.com - entry_type: AUTHOR id: tw:234 name: Pascal bird 234 parameters: - name: project_id in: path schema: type: string required: true example: a1ab1abc-a123-123a-123a-abcd12ab1a12 responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/source_panels/add?access_token=abcd_1234_abcd request_id: '#rx7k05h80vus#' result_source_panels: data: - success: true panel: id: ljmhvofx_1555babcd title: API Panel demo description: test by API color: '#f3a683' group_id: ungrouped_source_panels_group included_entries: - entry_type: URL site: ex url: www.testme.com exact_match: false - id: tw:234 entry_type: AUTHOR site: tw name: Pascal bird 234 /api/v2/talkwalker/p/{project_id}/source_panels/list: get: tags: - Source panels API summary: List all panels with their members description: To get a list of groups and panels with their members. parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/source_panels/list?access_token=abcd_1234_abcd request_id: '#rx7jghzy19o0#' result_source_panels: data: - group: id: predefined title: Predefined panels: - id: blocked - id: favourites - id: star1 included_entries: - id: ex:www.example_tw_dm.com-792524346 entry_type: AUTHOR site: ex name: Pascal2 - id: star2 - id: star3 - group: id: ungrouped title: Ungrouped panels: - id: lj4dn6yb_1555abcd title: API Panel demo description: test by API color: '#596275' included_entries: - entry_type: URL site: ex url: www.testme.com exact_match: false - id: tw:234 entry_type: AUTHOR site: tw name: Pascal bird 234 - group: id: leiecq1a_gabcdefvhq title: API group panels: - id: lespk2f4_gq0abcdeup title: VW Twitter Authors color: '#f7d794' included_entries: - id: tw:15221598 entry_type: AUTHOR site: tw name: 'James Gingerich #IndiaEnergyWeek #IoTSWC23' - id: tw:1592450289499484160 entry_type: AUTHOR site: tw name: B Nimisha /api/v2/talkwalker/p/{project_id}/source_panels/groups/add: post: tags: - Source panels API summary: Create a new group of panels description: Create one or multiple groups of source panels. Please note that it does not include the source panels inside the group. requestBody: content: application/json: schema: type: object example: groups: - title: API group - title: API group 2 parameters: - name: Content-Type in: header schema: type: string example: application/json; charset=UTF-8 - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/source_panels/groups/add?access_token=abcd_1234_abcd request_id: '#rx7jukacjfz4#' result_source_panels: data: - success: true group: id: ljmhrdij_1555babcd title: API group - success: true group: id: ljmhrdio_1555befgh title: API group 2 /api/v2/talkwalker/p/{project_id}/tags: get: description: List of custom tags defined in the Talkwalker project parameters: - example: a1ab1abc-a123-123a-123a-abcd12ab1a12 in: path name: project_id required: true schema: type: string responses: '200': content: application/json: example: request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/tags?access_token=abcd_1234_abcd request_id: '#r8w4z2a9f0w6#' result_tags: tags: - id: AX8G0S7Eo1ymquPAbjFf label: AI Tags/Bot - id: AX25FRouwrmZKQFrGoWW label: Category / news - id: AX25FjsBwrmZKQFrGouw label: Category / tv_clip - id: AXp1ysu8qhsP5DbNVS8Y label: isReported status_code: '0' status_message: OK schema: type: object description: OK summary: List of custom tags tags: - Resources API /api/v2/talkwalker/p/{project_id}/views: get: description: List of dashboards, reports and alerts defined in the Talkwalker project. parameters: - example: a1ab1abc-a123-123a-123a-abcd12ab1a12 in: path name: project_id required: true schema: type: string responses: '200': content: application/json: example: request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/views?access_token=abcd_1234_abcd request_id: '#r8w53fmn4lqc#' result_views: projects: - dashboards: - id: d|kpwljr81_5imm9n0rkoiy last_update: 1643363616716 title: My brand over time - id: d|kvm6rteh_1tucp7x76h74x last_update: 1636105165826 title: Twitter dashboard - id: d|ksq3qjwe_1tucp7xbajz8r last_update: 1641894004945 title: test API id: a1ab1abc-a123-123a-123a-abcd12ab1a12 reports: - id: r|ks5tu5bt_1tucp7xe5hxkb last_update: 1641894680353 title: test report - id: r|ks5twkt7_1tucp7xe5hzky last_update: 1632729761325 title: test alert title: Pascal's Project status_code: '0' status_message: OK schema: type: object description: OK summary: List of views tags: - Resources API /api/v2/talkwalker/p/{project_id}/custom_metrics/list: get: tags: - Resources API summary: List of custom metrics parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/custom_metrics/list?access_token=abcd_1234_abcd request_id: '#rkmdna3yrn54#' result_custom_metrics: data: - custom_metric: name: email title: Email description: '' display_in_ui: true update_ts: 1626449454677 format: name: KEYWORD - custom_metric: name: text title: Text description: '' display_in_ui: true update_ts: 1629473310655 format: name: TEXT - custom_metric: name: score title: Score description: '' display_in_ui: true update_ts: 1629473331535 format: name: INTEGER /api/v2/talkwalker/p/{project_id}/custom_metrics/add: post: tags: - Resources API summary: Add custom metrics requestBody: content: application/json: schema: type: object example: custom_metrics: - name: metric1 title: 1st metric description: '' display_in_ui: true format: INTEGER - name: metric2 title: text metric description: '' display_in_ui: true format: TEXT parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/custom_metrics/add?access_token=abcd_1234_abcd request_id: '#rxl4w6edcgbb#' result_custom_metrics: data: - custom_metric: name: metric1 title: 1st metric description: '' display_in_ui: true update_ts: 1689000198343 format: name: INTEGER success: true - custom_metric: name: metric2 title: text metric description: '' display_in_ui: true update_ts: 1689000198437 format: name: TEXT success: true /api/v2/talkwalker/p/{project_id}/custom_metrics/update: post: tags: - Resources API summary: Update custom metrics description: Changing the name or the type is not allowed. requestBody: content: application/json: schema: type: object example: custom_metrics: - name: metric1 title: 1st metric description: '' display_in_ui: false - name: metric2 title: Category description: '' display_in_ui: true parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/custom_metrics/update?access_token=abcd_1234_abcd request_id: '#rxl54hs4q8pm#' result_custom_metrics: data: - custom_metric: name: metric1 title: 1st metric description: '' display_in_ui: false update_ts: 1689000497379 format: name: INTEGER success: true - custom_metric: name: metric2 title: Category description: '' display_in_ui: true update_ts: 1689000497386 format: name: TEXT success: true /api/v2/talkwalker/p/{project_id}/custom_metrics/m/{metric_name}: delete: tags: - Resources API summary: Delete specific custom metric parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' - name: metric_name in: path schema: type: string required: true description: Custom metric's name example: metric1 responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: DELETE /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/custom_metrics/m/metric1?access_token=abcd_1234_abcd request_id: '#rxl5azv6ygmh#' result_custom_metrics: data: - custom_metric: name: metric1 success: true /api/v2/talkwalker/p/{project_id}/custom_metrics/delete: post: tags: - Resources API summary: Delete custom metrics description: Changing the name or the type is not allowed. requestBody: content: application/json: schema: type: object example: metric_names: - metric2 - variety_food3 parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/custom_metrics/delete?access_token=abcd_1234_abcd request_id: '#rxl5is2tsjc1#' result_custom_metrics: data: - custom_metric: name: metric2 success: true - custom_metric: name: variety_food3 success: true /api/v2/talkwalker/p/{project_id}/topics/delete: post: parameters: - example: a1ab1abc-a123-123a-123a-abcd12ab1a12 in: path name: project_id required: true schema: type: string requestBody: content: application/json: schema: example: bulk_topics: - category_id: l0v16esw_1555byucibc75 id: l0v16esw_1555byucibc74 - category_id: default id: l0v1c44o_1555bys20chuu type: object responses: '200': content: application/json: example: request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/topics/delete?access_token=abcd_1234_abcd request_id: '#r8w5wyfp26pp#' result_topic_deletion: bulk_answer: - category_id: l0v16esw_1555byucibc75 id: l0v16esw_1555byucibc74 success: true - category_id: default id: l0v1c44o_1555bys20chuu success: true status_code: '0' status_message: OK schema: type: object description: OK summary: Delete a batch of topics tags: - Topic API /api/v2/talkwalker/p/{project_id}/topics/import: post: parameters: - example: a1ab1abc-a123-123a-123a-abcd12ab1a12 in: path name: project_id required: true schema: type: string requestBody: content: application/json: schema: example: topic_line_import: - category_title: my new group included_query: true override: false query: cats topic_description: This is a topic description topic_title: my new topic topic_type: search type: object responses: '200': content: application/json: example: request: POST /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/topics/import?access_token=abcd_1234_abcd request_id: '#r8w5k4liu8js#' result_topics: filter_categories: - description: '' id: default_filter query_topics: - description: '' id: kszspjer_1tucp7xd2omic included_queries: - 'lang:fr ' title: test ungrouped title: '' topic_categories: - description: '' id: default query_topics: - description: '' excluded_queries: - (noisecategory:financial_news OR noisecategory:promotions) id: kpnutesu_5imm9mo4lbsj included_queries: - tesla AND "electric car" AND lang:en title: Tesla - description: '' id: kpnzh6u5_5imm9mo4kozc included_queries: - BMW AND electric AND car title: BMW title: '' - description: '' id: l0v16esw_1555byucibc75 query_topics: - description: This is a topic description id: l0v16esw_1555byucibc74 included_queries: - cats title: my new topic title: my new group status_code: '0' status_message: OK schema: type: object description: OK summary: Create or update a batch of topics tags: - Topic API /api/v2/talkwalker/p/{project_id}/topics/list: get: tags: - Topic API summary: List topics with definitions description: Retrieve the definition of all topics and custom filters parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/topics/list?access_token=abcd_1234_abcd request_id: '#rx7so7zw3fl0#' result_topics: topic_categories: - id: default title: '' description: '' query_topics: - id: kpnutesu_5immdyrglbsj title: Tesla description: '' included_queries: - tesla AND "electric car" AND lang:en excluded_queries: - 'noisecategory:hate_speech ' created_ts: 1623145323054 updated_ts: 1680849247501 color: '#596CBB' - id: kpnzh6u5_5imm9mo4kozc title: BMW description: '' included_queries: - BMW AND electric AND car created_ts: 1623153150941 updated_ts: 1680849247501 color: '#000000' - id: l2qamuys_1555baaaz47u title: Topic group 1 description: '' query_topics: - id: l3blj0n1_donwfawrgc6jo title: Test group description: '' included_queries: - electric AND car created_ts: 1652879080189 updated_ts: 1680849247501 color: '#F79646' filter_categories: - id: default_filter title: '' description: '' query_topics: - id: kszspjer_1tucdrgsd2omic title: test ungrouped description: '' included_queries: - 'lang:fr ' created_ts: 1630397724291 updated_ts: 1630399991344 color: '#0089C0' - id: converted_from_topic title: '' description: '' query_topics: - id: kprz90ma_5immrgrgz19oz title: Tesla on Twitter description: '' included_queries: - tesla AND "electric car" AND lang:en AND sourcetype:SOCIALMEDIA_TWITTER created_ts: 1623394634338 updated_ts: 1623397368613 color: '#596CBB' /api/v2/talkwalker/p/{project_id}/topics/list/{topic_id}: get: tags: - Topic API summary: Retrieve definition of a specific topic description: In order to only get the definition of a specific topic or custom filter when calling the endpoint, we can add the topic ID to the endpoint. parameters: - name: project_id in: path schema: type: string required: true example: '{{project_id}}' - name: topic_id in: path schema: type: string required: true description: topic ID or filter ID example: kpnutesu_5imm9mo4lbsj responses: '200': description: OK content: application/json: schema: type: object example: status_code: '0' status_message: OK request: GET /api/v2/talkwalker/p/a1ab1abc-a123-123a-123a-abcd12ab1a12/topics/list/kpnutesu_5imm9mo4lbsj?access_token=abcd_1234_abcd request_id: '#rbawwg5flbh7#' result_topic_details: id: kpnutesu_1234 title: Tesla description: '' category_id: default category_title: '' category_description: '' included_queries: - tesla AND "electric car" AND lang:en excluded_queries: - (noisecategory:financial_news OR noisecategory:promotions) type: SEARCH components: securitySchemes: apikeyAuth: in: query name: access_token type: apiKey