--- title: "P003 Analytics Query Search and Filter" method: POST path: "/search/patent/query/v2" tags: ["Patent Data Search"] --- # P003 Analytics Query Search and Filter `POST /search/patent/query/v2` ## Request - Base URL: `https://connect.patsnap.com` - URL: `https://connect.patsnap.com/search/patent/query/v2` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Receive the aggregated statistical results of specified field dimension, according to the search results of query. ## Request body - P003QueryV2Request - `query` string, required: Enter the Analytics Query, with a maximum length of 12,000 characters. - `field` string, required: Filter field dimension, please enter the field code, up to 5 fields are supported, separated by comma.

AUTHORITY: Authority (https://analytics.patsnap.com/status)

PATENT_TYPE: Patent Type（A: Applications B: Patents U: Utility models D: Designs AB: Applications+Patents）

PUBLICATION_YEAR: Publication Year

APPLICATION_YEAR: Application Year

ISSUE_YEAR: Issue Year

PRIORITY_YEAR: Priority Year

CURRENT_ASSIGNEE: Current Assignee

ORIGINAL_ASSIGNEE: Original Assignee (Applicant)

ASSIGNEE: Std. Current Assignee

STD_ORIGINAL_ASSIGNEE: Std. Original Assignee (Applicant)

INVENTOR: Inventor

AGENCY: Agency

ANCS_TYPE: Std. Current Assignee Type（ACADEMY, COMPANY, GOVERNMENT, PERSON, HOSPITAL, BANK, OTHER）

IPC: IPC

IPC_SECTION: IPC-IPC Section

IPC_CLASS: IPC-IPC Class

IPC_SUB_CLASS: IPC-IPC Sub Class

IPC_MAIN_GROUP: IPC-IPC Group

CPC: Main CPC

CPC_SECTION: CPC-CPC Section

CPC_CLASS: CPC-CPC Class

CPC_SUB_CLASS: CPC-CPC Sub Class

CPC_MAIN_GROUP: CPC-CPC Group

SIMPLE_LEGAL_STATUS: Simple Legal Status (0:Inactive 1:Active 2:Pending 220:PCT designated stage expired 221:PCT designated stage 999:Undetermined)

LEGAL_STATUS: Legal Status (1:Published 2:Examining 3:Granted 8:Double 11:Withdrawn 13:Rejected 14:Revoked 15:Expired 16:Non-payment 21:Restoration 22:Ceased 23:P-Revoked 24:Discontinuation 30:Abandoned 222:Non-Entry PCT-NP (In time limit)） 223:PCT-NP (In time limit) 224:PCT-NP (Past time limit) 225:Non-Entry PCT-NP (Past time limit))

LEGAL_EVENT: Legal Events (61:Transfer 62:License 63:Pledge 64:Trust 65:Opposition 66:Re-examination 69:Customs 70:Litigation 71:Preservation 72:Invalid-procedure 73:Oral-procedure 74:Declassification 75:Dual filing（Double application）)

- `lang` string: Select the language, the default language is cn, you can choose cn、en or jp. - `collapse_type` string: Select the collapse type, "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 - `collapse_by` string:

Select the sort field for patent collapse,

"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_order` string: Select the patent collapse ordering rule that is valid only if collapse_by is APD or PBD, setting OLDEST or LATEST to keep the earliest or latest one - `collapse_order_authority` unknown[]: Sets the order of patent collapse according to the input authorities priority list, valid only if collapse_by is AUTHORITY - unknown - `limit` integer, required: Returns the number of statistical results, 1 <= limit <= 100，default is 50 - `offset` integer, required: 0 <= offset+limit <= 200 - `stemming` integer:

Whether to turn on the stemming function, 1: turn on; 0: turn off. Off by default

Note:

Stemming ON will search for the original word and expand the search to consider singular, plural, and tense variations e.g. a search for "come" will expand to "comes", "came", "coming" and so on.

Stemming OFF will only search for exact matches of the keywords entered.

The use of wildcards in keywords within a search query will impact the effect of stemming.

Stemming ON only supports English words. Stemming does not apply to Assignees, Inventors, or any other person-related fields.

## Response `200` Successful p003 analytics query search and filter response. - P003QueryV2Response - `data` P003QueryV2MapStringListSearchPatentFieldResponse[]: response data (unresolved $ref) - `status` boolean, required: Status - `error_msg` string: Error Message - `error_code` integer, required: Error Code ## Other responses - `201`: Created. - `401`: Unauthorized. - `403`: Forbidden. - `404`: Not Found. --- [API](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api.md) - [All operations](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/revisions/c2264a0de595?raw)