What is the endpoint for [A012]Distribution of technical efficacy phrases?

The [A012]Distribution of technical efficacy phrases endpoint is POST https://connect.patsnap.com/insights/technology-effect-Distribution.

Where can I find the OpenAPI schema for [A012]Distribution of technical efficacy phrases?

The OpenAPI schema is available at /openapi.json#/paths/~1insights~1technology-effect-Distribution/post. You can also browse the full specification at /openapi.json.

[A012]Distribution of technical efficacy phrases

Q: What data can [A012]Distribution of technical efficacy phrases return?

[A012]Distribution of technical efficacy phrases By inputting the search formula, query the technical effects of the search formula and the focused technical research directions. It includes: functional phrases, the number of patents covered by the functional phrases, and the number of patents per year (the year of patent application, the number of patents). See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/insights/technology-effect-Distribution

Try in Sandbox

By inputting the search formula, query the technical effects of the search formula and the focused technical research directions. It includes: functional phrases, the number of patents covered by the functional phrases, and the number of patents per year (the year of patent application, the number of patents).

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`collapse_by`	`string`	`PBD`	"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`	`LATEST`	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
`collapse_order_authority`	`array`	`[ "CN", "US", "EP", "JP", "KR" ]`	Setting the patent collapse ordering rule that is valid only if collapse_by is AUTHORITY Sets the order of patent collapse according to the input authorities priority list, valid only if collapse_by is AUTHORITY
`collapse_type`	`string`	`DOCDB`	"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
`lang`	`string`	`cn`	Single-choice, available options include "cn" and "en", representing Chinese and English respectively. Please use lowercase letters. The default value is Chinese
`query_text` Required	`string`	`TACD: virtual reality`	Analytics query, maximum length 1,500 characters
`sort` Read-only	`array`	`[ { "field": "PBDT_YEARMONTHDAY", "order": "DESC" } ]`	Field order, field can support: PBDT_YEARMONTHDAY, APD_YEARMONTHDAY, ISD,SCORE; order can support: desc, asc.

Request Example

Example request body for this API endpoint

JSON

{
  "lang": "cn",
  "sort": [
    {
      "field": "PBDT_YEARMONTHDAY",
      "order": "DESC"
    }
  ],
  "query_text": "TACD: virtual reality",
  "collapse_by": "PBD",
  "collapse_type": "DOCDB",
  "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
`tech_effect`	`array`	`Please check the form: TechEffectCountResponse`	Statistics on the distribution of technical efficacy
`name`	`string`	`提高准确性`	benefit phrase
`count`	`integer<int32>`	`198`	patent count
`patent_count_year`	`array`	`Please check the form: TechEffectPatentCountYear`	Annual statistics of the number of patents covered by functional phrases
`count`	`integer<int32>`	`198`	patent count
`pbt_year`	`integer<int32>`	`2024`	patent application year
`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": {
    "tech_effect": [
      {
        "name": "提高准确性",
        "count": 198,
        "patent_count_year": [
          {
            "count": 198,
            "pbt_year": 2024
          }
        ]
      }
    ]
  },
  "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