What is the endpoint for [A101]Company Innovation Word Cloud?

The [A101]Company Innovation Word Cloud endpoint is GET https://connect.patsnap.com/insights-company/word-cloud.

Where can I find the OpenAPI schema for [A101]Company Innovation Word Cloud?

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

[A101]Company Innovation Word Cloud

Q: What data can [A101]Company Innovation Word Cloud return?

[A101]Company Innovation Word Cloud Understand the top keywords and phrases found in the latest 5000 publications in the company's portfolio.This is helpful to provide a snapshot view of the language used by the company in their filings. Returns up to the top 100 keywords. See the Response Schema and Success Response Example on this page for the full structure.

get

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

Try in Sandbox

Understand the top keywords and phrases found in the latest 5000 publications in the company's portfolio.This is helpful to provide a snapshot view of the language used by the company in their filings. Returns up to the top 100 keywords.

Please fill in the complete company_name to obtain the company analysis report.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`apply_end_time`	`string`	`2020`	Patent apply date to, format:yyyy
`apply_start_time`	`string`	`2010`	Patent apply date from, format:yyyy
`authority`	`string`	`CN OR EP`	Select the authority of the patent, the default query all databases, eg CN、US、EP、JP. To find more information, refer to https://analytics.zhihuiya.com/status. Example: US OR EP
`company_name`	`string`	`华为技术有限公司`	Query the name of a single enterprise
`lang` Required	`string`	`en`	Select the language , the default language is en, you can choose cn or en.
`patent_type`	`string`	`A OR B`	Patent application type A:Applications B: Patents U: Utility models D: Designs Multiple options can be selected, and multiple content items can be spliced with OR (there is a space between parameter and OR)
`public_end_time`	`string`	`2020`	Patent publication date to, format:yyyy
`public_start_time`	`string`	`2010`	Patent publication date from, format:yyyy
`simple_legal_status`	`string`	`1 OR 2`	Patent simple legal status 0-Inactive 1-Active 2-Pending 220-PCT designated stage expired n 221-PCT designated stage 999-Undetermined Multiple options can be selected, and multiple content items can be spliced with OR (there is a space between parameter and OR)

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!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms