[B057] 牛眼图分析

post
https://connect.zhihuiya.com/synapse/bull-eyes-plot
在体验中心中试用

获取牛眼图分析

检索条件中涉及的机构、靶点、适应症、药物类型默认都是向上卷积(Roll-Up)逻辑

请求参数

此 API 接口支持的参数列表

名称类型示例描述
limit
必填
integer<int64>10
返回条数，默认10条。仅支持10，20，30
dimension
必填
stringORGANIZATION
分析维度，枚举值：ORGANIZATION、TARGET、DISEASE、DRUG_TYPE、REGION
roll_up
booleantrue
分析结果是否向上卷积（Roll-up），仅分析维度为ORGANIZATION（机构）时生效，默认true
drug
object{ "value": [ "2838b95ade834c96b17ac8bcd2b68c27" ], "condition": "OR" }
药物，condition默认为OR，不支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[ "2838b95ade834c96b17ac8bcd2b68c27" ]
值列表
drug_type
object{ "value": [], "condition": "OR" }
药物类型，condition默认为OR，不支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[]
值列表
target
object{ "value": [], "condition": "OR" }
靶点，condition默认为OR，支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[]
值列表
mechanism_action
object{ "value": [], "condition": "OR" }
作用机制，condition默认为OR，不支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[]
值列表
disease
object{ "value": [], "condition": "OR" }
适应症，condition默认为OR，不支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[]
值列表
organization
object{ "value": [ "11ef8a9e8bf5ca80213a1183511cded3" ], "condition": "OR" }
机构，condition默认为OR，不支持AND。
condition
stringOR
逻辑运算符，枚举值：AND、OR， 大小写敏感。
value
array[ "11ef8a9e8bf5ca80213a1183511cded3" ]
值列表
global_highest_dev_status
array[]
最高研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
exist_deal
booleantrue
是否存在药物交易
dev_status
array[]
研发状态。枚举值：Discovery、Preclinical、IND、IND_Approval、Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、NDA_BLA、Approved、Clinical、Pending、Discontinued、Withdraw、Suspended、Unknown。
country
array[ "US", "EU" ]
国家地区。枚举值：US、EU、JP、CN、Other
organization_type
array[ "Company" ]
机构类型。枚举值：Company、University_Institution、Other
employee_number
array[ "GREATER_THAN_500" ]
雇员数量。枚举值：LESS_THAN_10、BETWEEN_10_AND_100、BETWEEN_100_AND_500、GREATER_THAN_500
start_up
boolean-
是否初创公司

响应结构

API 响应数据的结构说明

字段名类型示例描述
data
object-
响应数据
items
arrayPlease check the form:BullEyesPlotDto
查询结果
data
arrayPlease check the form:BullEyesPlotDto
牛眼图具体数据
drug
array[ { "drug_id": "07bf6b38be634718897783feeabef441", "drug_type": { "display_name": [ { "lang": "EN", "name": "Biological products" }, { "lang": "CN", "name": "生物药" } ], "normalized_id": "06bc75afc2f44364a9663730fa37c37a" }, "display_name": [ { "lang": "EN", "name": "VRON-0200" } ] }, { "drug_id": "e4cbc3790c5d4f299e8cd765585033ad", "drug_type": { "display_name": [ { "lang": "EN", "name": "Biological products" }, { "lang": "CN", "name": "生物药" } ], "normalized_id": "06bc75afc2f44364a9663730fa37c37a" }, "display_name": [ { "lang": "EN", "name": "Anti-EGFR/IL-13R alpha 2 CAR-T cell therapy(Tmunity Therapeutics/University of Pennsylvania)" } ] } ]
药物信息
drug_id
stringe82b83b42eba4e5ea3f26f8e06081a5a
药物ID
drug_type
object{ "display_name": [ { "lang": "EN", "name": "Biological products" }, { "lang": "CN", "name": "生物药" } ], "normalized_id": "06bc75afc2f44364a9663730fa37c37a" }
药物类型，引用“CommonDictionary”
display_name
array[ { "lang": "EN", "name": "Autologous CAR-T" }, { "lang": "CN", "name": "自体CAR-T" } ]
字典名称
lang
stringEN
语言
name
stringRanibizumab (Genentech)
药物、靶点、机构、适应症、国家/地区、字典、作用机制 名称
normalized_id
string2fbfdb3e92d942c48cbb0adb79f23526
字典ID
display_name
array[ { "lang": "EN", "name": "Ranibizumab (Genentech)" }, { "lang": "CN", "name": "雷珠单抗" } ]
药物名称，引用“CommonName”
un_know
array[ "e4cbc3790c5d4f299e8cd765585033ad" ]
未知药物类型的药物ID列表
stat_info
object{ "drug_type": [ { "display_name": [ { "lang": "EN", "name": "Biological products" }, { "lang": "CN", "name": "生物药" } ], "normalized_id": "06bc75afc2f44364a9663730fa37c37a" } ] }
统计信息
drug_type
array[ { "display_name": [ { "lang": "EN", "name": "Biological products" }, { "lang": "CN", "name": "生物药" } ], "normalized_id": "06bc75afc2f44364a9663730fa37c37a" } ]
药物类型，引用“CommonDictionary”
dev_status
object{ "display_name": [ { "lang": "EN", "name": "Phase 1" }, { "lang": "CN", "name": "临床1期" } ], "normalized_id": "e2c11c24a7ee4b4e81bbde9eb7127c6d" }
研发状态，引用“CommonDictionary”
related_drug_id
array[ "07bf6b38be634718897783feeabef441" ]
关联的药物ID列表
target
object[ { "target_id": "e49efee164e537c2a4ba9cec109e0adb", "short_name": [ { "lang": "EN", "name": "BCMA" } ], "display_name": [ { "lang": "EN", "name": "B-cell maturation protein" }, { "lang": "CN", "name": "B细胞成熟蛋白" } ] } ]
靶点，引用“CommonTarget”
target_id
string1c2067e5ab054a8995f73efcfcf56207
靶点ID
short_name
array[ { "lang": "EN", "name": "VEGF" } ]
靶点简称，引用“CommonName”
display_name
array[ { "lang": "EN", "name": "Vascular endothelial growth factor" }, { "lang": "CN", "name": "血管内皮生长因子" } ]
靶点全称，引用“CommonName”
country
object{ "country_id": "0dc5d896-7408-3c87-84c0-22e3d9b784be", "alpha2_code": "US", "display_name": [ { "lang": "EN", "name": "United States" }, { "lang": "CN", "name": "美国" } ] }
国家/地区，引用“CommonCountry”
country_id
string676de5ba-893a-36bb-8683-c93306aaf769
国家地区ID
alpha2_code
stringUS
国家编码
display_name
array[ { "lang": "EN", "name": "United States" }, { "lang": "CN", "name": "美国" } ]
国家地区名称
disease
object{ "disease_id": "05554578204541148a5482ad5df4a600", "display_name": [ { "lang": "EN", "name": "Glioblastoma Multiforme" }, { "lang": "CN", "name": "多形性胶质母细胞瘤" } ] }
适应症，引用“CommonDisease”
disease_id
string06a9082fe1ec4c97bea31d888b9cfdce
适应症ID
display_name
array[ { "lang": "EN", "name": "Uveitic Macular Edema" }, { "lang": "CN", "name": "葡萄膜炎黄斑水肿" } ]
适应症名称，引用“CommonName”
drug_type
object{ "display_name": [ { "lang": "EN", "name": "CAR-T" }, { "lang": "CN", "name": "CAR-T" } ], "normalized_id": "e9f267acd397430897163507bc9d735d" }
药物类型，引用“CommonDictionary”
organization
object{ "organization": { "display_name": [ { "lang": "EN", "name": "Hrain Biotechnology Co., Ltd." }, { "lang": "CN", "name": "上海恒润达生生物科技股份有限公司" } ], "organization_id": "b4c624212749f84e83429c5a8673c692" } }
机构，引用“CommonOrganization”
display_name
array[ { "lang": "EN", "name": "Roche Holding AG" }, { "lang": "CN", "name": "罗氏" } ]
机构名称，引用“CommonName”
organization_id
string87bfaf037f8e60c9e25595cd98bb27e4
机构ID
dimension
stringORGANIZATION
分析维度
status
必填
booleanfalse
状态
error_msg
stringThe request parameter format is incorrect！
错误信息
error_code
必填
integer0
错误代码

成功响应示例

成功调用 API 的响应示例

JSON 
{
  "data": {
    "items": [
      {
        "data": [
          {
            "drug": [
              {
                "drug_id": "e82b83b42eba4e5ea3f26f8e06081a5a",
                "drug_type": {
                  "display_name": [
                    {
                      "lang": "EN",
                      "name": "Ranibizumab (Genentech)"
                    }
                  ],
                  "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
                },
                "display_name": [
                  {
                    "lang": "EN",
                    "name": "Ranibizumab (Genentech)"
                  }
                ]
              }
            ],
            "un_know": [
              "e4cbc3790c5d4f299e8cd765585033ad"
            ],
            "stat_info": {
              "drug_type": [
                {
                  "display_name": [
                    {
                      "lang": "EN",
                      "name": "Ranibizumab (Genentech)"
                    }
                  ],
                  "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
                }
              ]
            },
            "dev_status": {
              "display_name": [
                {
                  "lang": "EN",
                  "name": "Ranibizumab (Genentech)"
                }
              ],
              "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
            },
            "related_drug_id": [
              "07bf6b38be634718897783feeabef441"
            ]
          }
        ],
        "target": {
          "target_id": "1c2067e5ab054a8995f73efcfcf56207",
          "short_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ],
          "display_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ]
        },
        "country": {
          "country_id": "676de5ba-893a-36bb-8683-c93306aaf769",
          "alpha2_code": "US",
          "display_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ]
        },
        "disease": {
          "disease_id": "06a9082fe1ec4c97bea31d888b9cfdce",
          "display_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ]
        },
        "drug_type": {
          "display_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ],
          "normalized_id": "2fbfdb3e92d942c48cbb0adb79f23526"
        },
        "organization": {
          "display_name": [
            {
              "lang": "EN",
              "name": "Ranibizumab (Genentech)"
            }
          ],
          "organization_id": "87bfaf037f8e60c9e25595cd98bb27e4"
        }
      }
    ],
    "dimension": "ORGANIZATION"
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码描述
68300004请求参数异常!
68300005查询Api失败!
68300006解析基本存取错误!
68300007存在错误的请求!
68300008服务中断异常，请稍后再试!
68300010文件不符合上传规范!

平台错误码

错误码描述
67200000API整体限流错误!
67200001API整体限流错误！
67200002当前调用速率过快,超过当前配置限制QPS！
67200003申请token的key和secret传参不正确或者客户端已被禁用！
67200004请求的接口无权限请联系我们的支持人员！
67200005账户余额/调用次数不足！
67200006客户端超过开通有效期！
67200007当前调用超过当天配置使用额度！
67200008请检查query参数中必填的apikey是否传输！
67200009apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
67200012请求不合法！
67200100当前服务器状态正忙,请求响应超时！
67200101当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码描述
0请求成功
201Created
401Unauthorized
403Forbidden
404Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms