What is the endpoint for [P002]Analytics Query Search?

The [P002]Analytics Query Search endpoint is POST https://connect.patsnap.com/search/patent/query-search-patent.

Where can I find the OpenAPI schema for [P002]Analytics Query Search?

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

[P002]Analytics Query Search

Q: What data can [P002]Analytics Query Search return?

[P002]Analytics Query Search returns PatSnap's global patent database using standard text queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. This includes patent count, patent number, and patent ID. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/search/patent/query-search-patent

Try in Sandbox

Search PatSnap's global patent database using standard text queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. This includes patent count, patent number, and patent ID.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`offset`	`integer<int32>`	-	offset value; limit + offset <= 20000 (the max number of Semantic Search is 1000)
`sort` Read-only	`array`	`[ { "field": "PBDT_YEARMONTHDAY", "order": "DESC" } ]`	Field order, field can support: PBDT_YEARMONTHDAY, APD_YEARMONTHDAY, ISD,SCORE; order can support: desc, asc.
`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
`limit`	`integer<int32>`	`10`	limit of returned response; must be <= 1,000
`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: virtual reality`	Analytics query, maximum length 1,500 characters

{
  "sort": [
    {
      "field": "PBDT_YEARMONTHDAY",
      "order": "DESC"
    }
  ],
  "limit": 10,
  "offset": 0,
  "query_text": "TACD: 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`	`object`	-	response data
`results`	`array`	`Please check the form: PatentBaseResponse`	result
`pn`	`string`	`US11205304B2`	patent number
`patent_id`	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`result_count`	`integer<int32>`	`10`	Received result count
`total_search_result_count`	`integer<int64>`	`1000`	Total search result count
`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": {
    "results": [
      {
        "pn": "US11205304B2",
        "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269"
      }
    ],
    "result_count": 10,
    "total_search_result_count": 1000
  },
  "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
`201`	Created
`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