[B057] 牛眼图分析的接口地址是什么？

[B057] 牛眼图分析的接口为 POST https://stage-connect.zhihuiya.com/synapse/bull-eyes-plot。

[B057] 牛眼图分析可以返回哪些数据？

[B057] 牛眼图分析：获取牛眼图分析。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B057] 牛眼图分析的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1synapse~1bull-eyes-plot/post，也可在 /openapi.json 浏览完整规范。

[B057] 牛眼图分析

Q: [B057] 牛眼图分析 的接口地址是什么？

[B057] 牛眼图分析 的接口为 POST https://stage-connect.zhihuiya.com/synapse/bull-eyes-plot。

post

https://stage-connect.zhihuiya.com/synapse/bull-eyes-plot

在体验中心中试用

获取牛眼图分析

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

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`limit` 必填	`integer<int64>`	`10`	返回条数，默认10条。仅支持10，20，30
`dimension` 必填	`string`	`ORGANIZATION`	分析维度，枚举值：ORGANIZATION、TARGET、DISEASE、DRUG_TYPE、REGION
`roll_up`	`boolean`	`true`	分析结果是否向上卷积（Roll-up），仅分析维度为ORGANIZATION（机构）时生效，默认true
`drug`	`object`	`{ "value": [ "81364d1ace044fdc8af8f60026eb2c7b" ], "condition": "OR" }`	药物，condition默认为OR，不支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`drug_type`	`object`	`{ "value": [ "9a847883d786485489d0ee1d75ae90ba" ], "condition": "OR" }`	药物类型，condition默认为OR，不支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`target`	`object`	`{ "value": [ "928facc8122849baa0dc00759cff0380" ], "condition": "OR" }`	靶点，condition默认为OR，支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`mechanism_action`	`object`	`{ "value": [ "4dd338b149b3ecd0ee860e1fb379b44f" ], "condition": "OR" }`	作用机制，condition默认为OR，不支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`disease`	`object`	`{ "value": [ "3beea980d93a4cc0abc864e27514601c" ], "condition": "OR" }`	适应症，condition默认为OR，不支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`organization`	`object`	`{ "value": [ "fa85404e9b2f62d55e5167ed2213eca7" ], "condition": "OR" }`	机构，condition默认为OR，不支持AND。引用“CommonConditionValue”
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "2838b95ade834c96b17ac8bcd2b68c27" ]`	值列表
`global_highest_dev_status`	`array`	`[ "Discovery", "Preclinical" ]`	最高研发状态。枚举值：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`	`boolean`	`true`	是否存在药物交易
`dev_status`	`array`	`[ "Discovery", "Preclinical" ]`	研发状态。枚举值：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`	`true`	是否初创公司

{
  "drug": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "limit": 10,
  "target": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "country": [
    "US",
    "EU"
  ],
  "disease": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "roll_up": true,
  "start_up": true,
  "dimension": "ORGANIZATION",
  "drug_type": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "dev_status": [
    "Discovery",
    "Preclinical"
  ],
  "exist_deal": true,
  "organization": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "employee_number": [
    "GREATER_THAN_500"
  ],
  "mechanism_action": {
    "value": [
      "2838b95ade834c96b17ac8bcd2b68c27"
    ],
    "condition": "OR"
  },
  "organization_type": [
    "Company"
  ],
  "global_highest_dev_status": [
    "Discovery",
    "Preclinical"
  ]
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`items`	`array`	`Please check the form:BullEyesPlotDto`	查询结果
`data`	`array`	`Please 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`	`string`	`e82b83b42eba4e5ea3f26f8e06081a5a`	药物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`	`string`	`EN`	语言
`name`	`string`	`Ranibizumab (Genentech)`	药物、靶点、机构、适应症、国家/地区、字典、作用机制名称
`normalized_id`	`string`	`2fbfdb3e92d942c48cbb0adb79f23526`	字典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`	`string`	`1c2067e5ab054a8995f73efcfcf56207`	靶点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`	`string`	`676de5ba-893a-36bb-8683-c93306aaf769`	国家地区ID
`alpha2_code`	`string`	`US`	国家编码
`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`	`string`	`06a9082fe1ec4c97bea31d888b9cfdce`	适应症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`	`string`	`87bfaf037f8e60c9e25595cd98bb27e4`	机构ID
`dimension`	`string`	`ORGANIZATION`	分析维度
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 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`	文件不符合上传规范!

平台错误码

错误码	描述
`67200001`	API整体限流错误!
`67200002`	用户调用请求限流限制错误!
`67200003`	申请token的key和secret不正确或者状态错误!
`67200004`	无权限或该接口的套餐已超过系统设置的上限!
`67200005`	账户余额不足，调用失败!
`67200006`	客户端已过期，调用失败!
`67200007`	超过调用额度，调用失败!

HTTP 状态码

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

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms