What is the endpoint for [P003]Analytics Query Search and Filter?

The [P003]Analytics Query Search and Filter endpoint is POST https://connect.patsnap.com/patent-field/query.

Where can I find the OpenAPI schema for [P003]Analytics Query Search and Filter?

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

[P003]Analytics Query Search and Filter

Q: What data can [P003]Analytics Query Search and Filter return?

[P003]Analytics Query Search and Filter According to the search query, the corresponding filtering results are obtained, and the filtering results are optional. See the Response Schema and Success Response Example on this page for the full structure.

post

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

Try in Sandbox

According to the search query, the corresponding filtering results are obtained, and the filtering results are optional.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`field` Required	`string`	`ASSIGNEE`	Filter item result set, please enter the field code, up to 5 fields are supported, separated by comma. ASSIGNEE: standard - the current applicant (patent) ANCS_TYPE: indicates the type of the applicant（ACADEMY COMPANY GOVERNMENT PERSON HOSPITAL BANK OTHER） INVENTOR: the inventor SIMPLE_LEGAL_STATUS: simple legal status (0: invalid 1: valid 2: under review 220: PCT specified period 221: PCT specified period 999: unconfirmed) LEGAL_STATUS: Legal status (1: disclosure 2: substantive review 3: authorization 8: avoidance of reauthorization 11: withdrawal 13: rejection 14: full cancellation 15: expiration 16: unpaid annual fee 21: restoration of rights 22: Termination of rights 23: Partial invalidation 24: application for termination 30: Abandonment 222: PCT International Announcement 223: PCT enters designated country (specified period) 224: PCT enters designated country (specified period) 225: PCT does not enter designated country) LEGAL_EVENT: Legal events (61: transfer of rights 62: License 63: pledge 64: trust 65: objection 66: review 69: Customs record 70: litigation 71: preservation 72: Invalid procedure 73: oral hearing 74: Declassification of National Defense 75: Double Application in one Case) APPLICATION_YEAR: application year PUBLICATION_YEAR: public year ISSUE_YEAR: entitlement year AGENCY: the agency PATENT_TYPE: patent type（A: Applications B: Patents U: Utility models D: Designs AB: Applications+Patents） AUTHORITY: (https://analytics.patsnap.com/status)
`lang`	`string`	`cn`	Select the language, the default language is cn, you can choose cn、en or jp.
`limit` Required	`integer<int32>`	`50`	Returns the number of statistical results, 1 <= limit <= 100，default is 50
`offset` Required	`integer<int32>`	-	0 <= offset+limit <= 200
`query` Required	`string`	`TTL:汽车`	query

{
  "lang": "cn",
  "field": "ASSIGNEE",
  "limit": 50,
  "query": "TTL:汽车",
  "offset": 0
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`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

{
  "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
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

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