What is the endpoint for [D101]life cycle data?

The [D101]life cycle data endpoint is POST https://connect.patsnap.com/shhgy/reportdata/life-cycle.

Where can I find the OpenAPI schema for [D101]life cycle data?

The OpenAPI schema is available at /openapi.json#/paths/~1shhgy~1reportdata~1life-cycle/post. You can also browse the full specification at /openapi.json.

[D101]life cycle data

Q: What data can [D101]life cycle data return?

[D101]life cycle data This interface is a statistical analysis interface that provides the number of patent applications per year over the past 10 years, as well as the number of invention patent applications. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/shhgy/reportdata/life-cycle

Try in Sandbox

This interface is a statistical analysis interface that provides the number of patent applications per year over the past 10 years, as well as the number of invention patent applications.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`collapse_order`	`string`	`LATEST`	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
`query_text` Required	`string`	`TACD_ALL:(patsnap)`	Enter the Analytics Query, with a maximum length of 800 characters and cannot contain complex wildcards such as $W $PRE $WS $SEN $PARA $FREQ .etc
`sort`	`array`	`[ { "field": "score", "order": "desc" } ]`	field order
`field`	`string`	`score`	sort field
`order`	`string`	`desc`	asc OR desc
`collapse_type`	`string`	`ALL`	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`	`PBD`	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_authority`	`array`	`[ "CN", "US", "EP", "JP", "KR" ]`	Sets the order of patent collapse according to the input authorities priority list, valid only if collapse_by is AUTHORITY

Request Example

Example request body for this API endpoint

JSON

{
  "sort": [
    {
      "field": "score",
      "order": "desc"
    }
  ],
  "query_text": "TACD_ALL:(patsnap)",
  "collapse_by": "PBD",
  "collapse_type": "ALL",
  "collapse_order": "LATEST",
  "collapse_order_authority": [
    "CN",
    "US",
    "EP",
    "JP",
    "KR"
  ]
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`values`	`array`	`[]`	values
`year`	`string`	`2015`	year
`total`	`integer<int32>`	`12000`	total num
`inv_total`	`integer<int32>`	`1000`	invent total num
`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": {
    "values": [
      {
        "year": 2015,
        "total": 12000,
        "inv_total": 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
`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