What is the endpoint for [P001]Analytics Query Search Count?

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

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

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

[P001]Analytics Query Search Count

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

[P001]Analytics Query Search Count returns PatSnap's global patent database using standard text queries, to get total search patent count of different queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.com/search_helper. See the Response Schema and Success Response Example on this page for the full structure.

post

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

Try in Sandbox

Search PatSnap's global patent database using standard text queries, to get total search patent count of different queries. Read about the search syntax supported in PatSnap here - https://analytics.patsnap.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
`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

{
  "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
`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": {
    "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