What is the endpoint for [A002]Innovation Word Cloud （Query Search）?

The [A002]Innovation Word Cloud （Query Search） endpoint is POST https://connect.patsnap.com/insights/word-cloud-query.

Where can I find the OpenAPI schema for [A002]Innovation Word Cloud （Query Search）?

The OpenAPI schema is available at /openapi.json#/paths/~1insights~1word-cloud-query/post. You can also browse the full specification at /openapi.json.

[A002]Innovation Word Cloud （Query Search）

Q: What data can [A002]Innovation Word Cloud （Query Search） return?

[A002]Innovation Word Cloud （Query Search） 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. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/insights/word-cloud-query

Try in Sandbox

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.

Note: The query_text field is necessary, PatSnap search syntax can refer to: https://analytics.zhihuiya.com/search_helper.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`collapse_order`	`string`	`LATEST`	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`	`PBD`	"APD" means order according to application date; "PBD" means order according to publication date; "AUTHORITY" means order according to authority; "SCORE" means order according to the relevance score
`lang` Required	`string`	`cn`	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`	`DOCDB`	"ALL" or Null value means no collapse; "APNO" means collapse according to application number; "DOCDB" means collapse according to simple family; "INPADOC" means collapse according to inpadoc family; "EXTEND" means collapse according to patsnap family
`query_text` Required	`string`	`TACD_ALL:(virtual reality)`	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

Request Example

Example request body for this API endpoint

JSON

{
  "lang": "cn",
  "query_text": "TACD_ALL:(virtual reality)",
  "collapse_by": "PBD",
  "collapse_type": "DOCDB",
  "collapse_order": "LATEST"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`name`	`string`	`electronic device`	Key concepts
`count`	`integer<int32>`	`37`	Patents
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": [
    {
      "name": "electronic device",
      "count": 37
    }
  ],
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!

HTTP Status Codes

Status Code	Description
`0`	Success