What is the endpoint for [B010-1]Drug related patent aggregation?

The [B010-1]Drug related patent aggregation endpoint is POST https://connect.patsnap.com/synapse/patent/relate/aggregation.

What data can [B010-1]Drug related patent aggregation return?

[B010-1]Drug related patent aggregation Obtain Aggregated information through drug, target, disease, etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B010-1]Drug related patent aggregation?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1patent~1relate~1aggregation/post. You can also browse the full specification at /openapi.json.

[B010-1]Drug related patent aggregation

post

https://connect.patsnap.com/synapse/patent/relate/aggregation

Try in Sandbox

Obtain Aggregated information through drug, target, disease, etc.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`drug`	`object`	`{ "value": [ "928facc8122849baa0dc00759cff0380" ], "condition": "OR" }`	Drug, The "condition" field defaults to OR and support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`drug_patent_type`	`string`	`PRODUCT_COMPOUND_SEQUENCE`	Drug patent type. The value is an enum with the following values: PRODUCT_COMPOUND_SEQUENCE, DRUG_COMBINATION_FORMULATION, PRODUCT_DERIVATIVE, CRYSTAL_FORM, PROCESS, NEW_USE, DOSAGE_FORM, DEVICE, DIAGNOSTIC_ANALYSIS_AND_ASSAY, OTHERS
`drug_type`	`object`	`{ "value": [ "a13258eede9446d0b1a919a20e84bc3b" ], "condition": "OR" }`	Drug type ID, The "condition" field defaults to OR and not support AND, obtain this through the dictionary query interface
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`patent_tech_type`	`object`	`{ "value": [ "1a04711d6e304f36a84fc9a06dc2edb3" ], "condition": "OR" }`	Patent technology ID, The "condition" field defaults to OR and not support AND, obtain this through the dictionary query interface
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`target`	`object`	`{ "value": [ "928facc8122849baa0dc00759cff0380" ], "condition": "OR" }`	Target, The "condition" field defaults to OR and support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`disease`	`object`	`{ "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }`	Indication, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`source`	`string`	`FDA_PURPLE_BOOK`	Patent Source. The value is an enum with the following values: FDA_PURPLE_BOOK, FDA_ORANGE_BOOK, CDE, MEDSPAL, VAXPAL, MFDS
`patent_assignee`	`object`	`{ "value": [ "fa85404e9b2f62d55e5167ed2213eca7" ], "condition": "OR", "keyword_value": [ "安进" ] }`	Assignee id
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`keyword_value`	`array`	`[ "安进" ]`	Keywrod List
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	Value List
`patent_country`	`array`	`[ "US" ]`	Authority, obtain this through the dictionary query interface
`simple_legal_status`	`array`	`[ "INACTIVE" ]`	Simple Legal Status. The value is an enum with the following values: INACTIVE, ACTIVE, PENDING, PCT_DESIGNATED_STAGE, PCT_DESIGNATED_STAGE_EXPIRED, UNDETERMINED
`pbdt`	`object`	`{ "to": 20240822, "from": 20240122 }`	Application date, format：yyyyMMdd，such as：20240522
`from`	`integer<int64>`	`20240122`	from
`to`	`integer<int64>`	`20240822`	to
`apdt`	`object`	`{ "to": 20240822, "from": 20240122 }`	Application date, format：yyyyMMdd，such as：20240522
`from`	`integer<int64>`	`20240122`	from
`to`	`integer<int64>`	`20240822`	to
`exdt`	`object`	`{ "to": 20240822, "from": 20240122 }`	Estimated expiry date, format：yyyyMMdd，such as：20240522
`from`	`integer<int64>`	`20240122`	from
`to`	`integer<int64>`	`20240822`	to
`aggregation_field`	`array`	`[ "PHS_CORE_DRUG_ID" ]`	Aggregation field : PHS_CORE_DRUG_ID: Patent Drug PHS_DRUG_TYPE_ID: Drug Type PHS_CORE_TYPE_ID: Drug Patent Type PATENT_TECHNOLOGY: Patent Tech Type COUNTRY: Authority FAM_COUNTRY: Simple Family Jurisdiction EXDT_Y: Estimated Expiry Year PHS_THERAPEUTIC_AREA: Therapeutic Area PHS_ORG_ID_ONEID: Std. Current Assignee ANCS_TYPE: Std. Current Assignee Type PHS_ANS_ORG_ID_ONEID: Std. Original Assignee ANS_TYPE: Std. Original Assignee Type IN_FACET: Inventor PHS_EXTENSION_TYPE: Extension Type SPC_STATUS: SPC Status SPC_COUNTRY: SPC Country/Location SPC_EXPIRY_DATE: SPC Expiry Year PED_STATUS: PED Status PED_EXPIRY_DATE: PED Expiry Year PTE_STATUS: PTE Status PTE_COUNTRY: PTE Country/Location PTE_EXPIRY_DATE: PTE Expiry Year PHS_CORE_DRUG_SOURCE: Information Source APD_YEAR: Application Year PBDT_YEAR: Publication Year PHS_DRUG_ID: Related Drug PHS_TARGET_ID: Related Target PHS_DISEASE_ID: Related Indications PHS_DOSAGE_FORM_ID: Related Dosage Form SIMPLE_LEGAL_STATUS: Simple Legal Status LEGAL_STATUS: Legal Status

Request Example

Example request body for this API endpoint

JSON

{
  "apdt": {
    "to": 20240822,
    "from": 20240122
  },
  "drug": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "exdt": {
    "to": 20240822,
    "from": 20240122
  },
  "pbdt": {
    "to": 20240822,
    "from": 20240122
  },
  "source": "FDA_PURPLE_BOOK",
  "target": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "disease": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "drug_type": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "patent_country": [
    "US"
  ],
  "patent_assignee": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "drug_patent_type": "PRODUCT_COMPOUND_SEQUENCE",
  "patent_tech_type": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR",
    "keyword_value": [
      "安进"
    ]
  },
  "aggregation_field": [
    "PHS_CORE_DRUG_ID"
  ],
  "simple_legal_status": [
    "INACTIVE"
  ]
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`aggregation_result`	`array`	[ { "items": [ { "key": "3db27f57784548dc96356669deee2ca1", "count": 333567, "display_name_cn": "单克隆抗体", "display_name_en": "Monoclonal antibody (mAb)" }, { "key": "33f8f531f649466e963f3dd5e371930d", "count": 16534, "display_name_cn": "多克隆抗体", "display_name_en": "Polyclonal antibody" }, { "key": "b926f94af96c439088bb020c3c774a47", "count": 16224, "display_name_cn": "放射标记抗体", "display_name_en": "Radiolabeled antibody" }, { "key": "1d4d0871a9c34266bbed06f44368fac8", "count": 16000, "display_name_cn": "抗体片段偶联药物", "display_name_en": "Antibody Fragment-Drug Conjugate (FDC)" }, { "key": "7e19a4b3743a47e48884bafeaec85b84", "count": 15518, "display_name_cn": "ADC", "display_name_en": "Antibody drug conjugate (ADC)" } ], "total": 5, "aggregation_field": "PATENT_TECHNOLOGY" } ]	Aggregation result
`items`	`array`	[ { "key": "3db27f57784548dc96356669deee2ca1", "count": 333567, "display_name_cn": "单克隆抗体", "display_name_en": "Monoclonal antibody (mAb)" }, { "key": "33f8f531f649466e963f3dd5e371930d", "count": 16534, "display_name_cn": "多克隆抗体", "display_name_en": "Polyclonal antibody" }, { "key": "b926f94af96c439088bb020c3c774a47", "count": 16224, "display_name_cn": "放射标记抗体", "display_name_en": "Radiolabeled antibody" }, { "key": "1d4d0871a9c34266bbed06f44368fac8", "count": 16000, "display_name_cn": "抗体片段偶联药物", "display_name_en": "Antibody Fragment-Drug Conjugate (FDC)" }, { "key": "7e19a4b3743a47e48884bafeaec85b84", "count": 15518, "display_name_cn": "ADC", "display_name_en": "Antibody drug conjugate (ADC)" } ]	Details of aggregation items
`key`	`string`	`676de5ba-893a-36bb-8683-c93306aaf769`	Primary key
`color`	`string`	`#6B778C`	Color(Return when the aggregated fields are SIMPLE_LEGAL_STATUS and LEGAL_STATUS)
`count`	`integer<int64>`	`10`	Quantity
`display_name_cn`	`string`	`Polyclonal antibody`	English display name
`display_name_en`	`string`	`多克隆抗体`	Chinese display name
`total`	`integer<int64>`	`5`	The number of aggregated items
`aggregation_field`	`string`	`PATENT_TECHNOLOGY`	Aggregated field
`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": {
    "aggregation_result": [
      {
        "items": [
          {
            "key": "676de5ba-893a-36bb-8683-c93306aaf769",
            "color": "#6B778C",
            "count": 10,
            "display_name_cn": "Polyclonal antibody",
            "display_name_en": "多克隆抗体"
          }
        ],
        "total": 5,
        "aggregation_field": "PATENT_TECHNOLOGY"
      }
    ]
  },
  "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