Patent Data Search [P001]Analytics Query Search Count
[P001]Analytics Query Search CountPublicV1
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.
Basic Information
Resource URL: /search/patent/query-search-count
Request Mode: post
Return Format: application/json
The API can only be called after logging in, click to log in
Try in Sandbox
Debug Here
API Description Document Download
Request Parameters
body
QuerySearchCountRequest
Parameter | Type | Required | Description | Sample |
collapse_order | string | false | 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 | LATEST |
collapse_by | string | false | "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 | PBD |
collapse_type | string | false | "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 | DOCDB |
query_text | string | true | Analytics query, maximum length 1,500 characters | TACD: virtual reality |
Request Sample
curl -X POST "https://connect.patsnap.com/search/patent/query-search-count?apikey="
-H "Content-Type:application/json"
-H "authorization:Bearer {token}"
-d '{"query_text":"TACD: virtual reality","collapse_by":"PBD","collapse_type":"DOCDB","collapse_order":"LATEST"}'
Copy
Response Parameters
CommonResponse
Parameter | Type | Required | Description | Sample |
data | object | false | response data | no sample |
status | boolean | true | Status | false |
error_msg | string | false | Error Message | The request parameter format is incorrect! |
error_code | integer | true | Error Code | 0 |
SearchPatentCountResponse
Parameter | Type | Required | Description | Sample |
total_search_result_count | integer | false | Total search result count | 1000 |
Response Error Details
error_code | Description |
0 | Success |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
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! |
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! |
Response Body
{
"data": {
"total_search_result_count": 1000
},
"status": true,
"error_code": 0
}
Copy
[P002]Analytics Query Search