---
title: "A002 Innovation Word Cloud （Query Search）"
method: POST
path: "/insights/word-cloud-query"
tags: ["Technology Key Report"]
---

# A002 Innovation Word Cloud （Query Search）

`POST /insights/word-cloud-query`

## Request

- Base URL: `https://connect.patsnap.com`
- URL: `https://connect.patsnap.com/insights/word-cloud-query`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/docs/insights/word-cloud-query/post.ts> (a function with typed inputs; its response is checked against the schema)

This API uses Query to search the most popular technical keywords, helping you analyze the latest research and development topics. Extracted the most common technical keywords from the last 5000 patents within the search query range.

## Request body

- A002InsightsWordCloudQueryRequest
  - `collapse_order` string: When collapse_type="APNO", and collapse_by="APD" or "PBD", the collapse_order can be set as "OLDEST" or "LATEST", means keep the patent date of oldest or latest one
  - `collapse_by` string: <p>"APD" means order according to application date;</p><p>"PBD" means order according to publication date;</p><p>"AUTHORITY" means order according to authority;</p><p>"SCORE" means order according to the relevance score</p>
  - `lang` string, required: Enter the language, single choice, options include cn, en, and jp, which are Chinese, English, and Japanese respectively. Please use lowercase letters.
  - `collapse_type` string: <p>"ALL" or Null value means no collapse;</p><p>"APNO" means collapse according to application number;</p><p>"DOCDB" means collapse according to simple family;</p><p>"INPADOC" means collapse according to inpadoc family;</p><p>"EXTEND" means collapse according to patsnap family</p>
  - `query_text` string, required: Enter the Analytics Query, with a maximum length of 800 characters and cannot contain complex wildcards such as $W $PRE $WS $SEN $PARA $FREQ .etc

## Response `200`

Successful a002 innovation word cloud （query search） response.

- A002InsightsWordCloudQueryResponse
  - `data` A002InsightsWordCloudQueryWordCloudResponse[]: response data
    - `name` string: Key concepts
    - `count` integer: Patents
  - `status` boolean, required: Status
  - `error_msg` string: Error Message
  - `error_code` integer, required: Error Code

---

[API](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api.md) - [All operations](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/revisions/c2264a0de595?raw)