What is the endpoint for [P055]Create export task by query?

The [P055]Create export task by query endpoint is POST https://connect.patsnap.com/patent-search/export.

Where can I find the OpenAPI schema for [P055]Create export task by query?

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

[P055]Create export task by query

Q: What data can [P055]Create export task by query return?

[P055]Create export task by query Allows to search our global patent repository using the standard PatSnap search query and retrieve the resulting data in bulk. Query syntax can be as simple as a list of keywords or as complex as a 12,000 character boolean query. To find more information about PatSnap search syntax, refer to https://analytics.patsnap.com/search_helper. Allows to select what patent fields should be returned in response to the query and, thus, allows control over the size of the response payload to help optimize performance, fields that are allowed to be exported, the fields and field levels that are allowed to be exported (different levels of fields have different calling fees). please link the export instructions . See the Response Schema and Success Response Example on this page for the full structure.

post

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

Try in Sandbox

Allows to search our global patent repository using the standard PatSnap search query and retrieve the resulting data in bulk. Query syntax can be as simple as a list of keywords or as complex as a 12,000 character boolean query. To find more information about PatSnap search syntax, refer to https://analytics.patsnap.com/search_helper. Allows to select what patent fields should be returned in response to the query and, thus, allows control over the size of the response payload to help optimize performance, fields that are allowed to be exported, the fields and field levels that are allowed to be exported (different levels of fields have different calling fees). please link the export instructions.

1. For full_text export type, only the following four fields PN, ABST, CLMS, DESC are supported. The field DESC is only supported by the full_text export type. The field CLMS is only supported by the full_text/pdf export type. Result of the full_text export type is a ZIP file including some xml files named by PN.

2.The size of the resulting set is limited to the top 100k most relevant patents.

3.This API deducts fees according to the actual amount of exported patents, please pay attention to the setting of limit parameter.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`query_text` Required	`string`	`TTL:car`	Patent search query, detailed syntax reference can be found at https://analytics.patsnap.com/search_helper
`fields` Required	`string`	`PN,APNO`	Fields that are allowed to be exported. See export instructions for details. Separate multiple export fields in English,.
`export_type` Required	`string`	`csv`	File formats that are allowed to be exported. You can choose json, csv, xls, pdf, full_text, xml. Only 1 can be selected. For full_text export type, only the following four fields PN, ABST, CLMS, DESC are supported. The field DESC is only supported by the full_text export type. The field CLMS is only supported by the full_text/pdf export type. Result of the full_text export type is a ZIP file including some xml files named by PN.
`rows` Required	`integer<int32>`	`100`	rows >= 1 , Single maximum export (csv/xls/json/xml: 100k , pdf/full_text: 1k)
`apdt_from`	`string`	`20110101`	Application date start. Format: 'yyyyMMdd', or * means time is unlimited
`apdt_to`	`string`	`20180619`	Application date end. Format: 'yyyyMMdd', or * means time is unlimited
`pbdt_from`	`string`	`20110101`	Publication date start. Format: 'yyyyMMdd', or * means time is unlimited
`pbdt_to`	`string`	`20180619`	Publication date end. Format: 'yyyyMMdd', or * means time is unlimited
`collapse_type`	`string`	`DOCDB`	Sets criterias for choosing representative documents that matching query conditions along with collapse_by and collapse_order. The valid value should be one of ALL indicating results will not be collapsed, APNO indicating only one document will be returned for each application, DOCDB indicating only one representative document will be returned for each simple family, INPADOC indicating only one representative document will be returned for each INPADOC family and EXTEND indicating only one representative document will be returned for each extended family. If provided collapse_type is null, the default value ALL will be used.
`collapse_by`	`string`	`APD`	Sets criterias for choosing representative documents that matching query conditions along with collapse_type and collapse_order. Controls the sort field when collapsing documents. The valid value should be one of APD indicating the application date, PBD indicating the publication date, AUTHORITY indicating the jurisdiction, and SCORE indicating the relevance between the query conditions and documents. If the collapse_type is ALL or APNO, the value of collapse_by will be ignored.
`collapse_order`	`string`	`OLDEST`	Sets criterias for choosing representative documents that matching query conditions along with collapse_type and collapse_by. Controls the sort order when collapsing documents. If the collapse_type is APNO, or the collapse_by is APD or PBD, the valid value should be one of OLDEST and LATEST. Otherwise, the value of collapse_order will be ignored
`lang`	`string`	`en`	Select the language , the default language is en, you can choose cn, en, jp, de, fr, kr.
`trans_lang`	`string`	`en`	Select the translation language , the default language is en, you can choose cn, en, jp.
`offset`	`integer<int32>`	-	0 <= rows + offset <= 100000, default is 0 If you want to get patents that are ranked lower than 100, you can set offset=100
`stemming`	`integer<int32>`	-	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.

{
  "lang": "en",
  "rows": 100,
  "fields": "PN,APNO",
  "offset": 0,
  "apdt_to": 20180619,
  "pbdt_to": 20180619,
  "stemming": 0,
  "apdt_from": 20110101,
  "pbdt_from": 20110101,
  "query_text": "TTL:car",
  "trans_lang": "en",
  "collapse_by": "APD",
  "export_type": "csv",
  "collapse_type": "DOCDB",
  "collapse_order": "OLDEST"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`count`	`integer<int32>`	`24`	Export number of patents
`task_id`	`string`	`b4bdae6b4a65432d91f25b5c52bdfd80`	Task ID is valid for 24 hours
`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": {
    "count": 24,
    "task_id": "b4bdae6b4a65432d91f25b5c52bdfd80"
  },
  "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