What is the endpoint for [P053]Achievement transformation - operation situation indicators?

The [P053]Achievement transformation - operation situation indicators endpoint is POST https://connect.patsnap.com/patent-valuation-data/operation_situation.

Where can I find the OpenAPI schema for [P053]Achievement transformation - operation situation indicators?

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

[P053]Achievement transformation - operation situation indicators

post

https://connect.patsnap.com/patent-valuation-data/operation_situation

Try in Sandbox

Receive technology operation situation indicators by similar patents list. there include the number of operated patents, inactive patents and invalid patents and multiple country coverage.

Up to 100 similar patents were supported for index calculation

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`family_threshold`	`integer<int32>`	`2`	simple family countries coverage threshold, for multiple_country_coverage (default 2)
`patent_info` Required	`array`	`[ { "pn": "CN113556455A", "patent_id": "d827b76d-3a0e-40a5-b63d-b8a47eb8d0f6", "relevancy": "74%" }, { "pn": "CN111634234A", "patent_id": "0e70c3f3-644d-4f65-abad-ad5630911dde", "relevancy": "73%" } ]`	List of similar patent information, up to 100 similar patents are supported for indicator calculation. Note: 1. patent_id and pn must have one, if both exist, the patent patent_id will be used first 2. patent_id or pn must be the patent ID and publication number in Patsnap database
`relevancy`	`string`	`99%`	relevancy between the result patent and the input content
`patent_id` Required	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`pn` Required	`string`	`US11205304B2`	patent number

Request Example

Example request body for this API endpoint

JSON

{
  "patent_info": [
    {
      "pn": "US11205304B2",
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
      "relevancy": "99%"
    }
  ],
  "family_threshold": 2
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`indicators`	`object`	`Please check the form: Indicators`	Operation situation indicators
`invalid_patent_count`	`integer<int32>`	`5`	Number of similar patents with invalid events
`inactive_patent_count`	`integer<int32>`	`10`	Number of similar patents invalidated because of non-payment
`operated_patent_count`	`integer<int32>`	`10`	Number of similar patents with transfer, license, or pledge events
`multiple_country_coverage`	`integer<int32>`	`10`	Number of similar patents with simple family covering multiple countries
`patent_info`	`array`	`Please check the form: Patent_info`	Patent information
`pn` Required	`string`	`US11205304B2`	patent number
`patent_id` Required	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`is_invalid`	`integer<int32>`	`1`	Whether the patent has Invalid-procedure
`is_inactive`	`integer<int32>`	`1`	Whether the patent expires because of non-payment
`is_operated`	`integer<int32>`	`1`	Whether the patent is transfered, licensed, or pledged
`country_cover_cnt`	`integer<int32>`	`2`	Number of countries covered by the simple family
`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": {
    "indicators": {
      "invalid_patent_count": 5,
      "inactive_patent_count": 10,
      "operated_patent_count": 10,
      "multiple_country_coverage": 10
    },
    "patent_info": [
      {
        "pn": "US11205304B2",
        "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
        "is_invalid": 1,
        "is_inactive": 1,
        "is_operated": 1,
        "country_cover_cnt": 2
      }
    ]
  },
  "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