Patsnap Drug Visual Analysis API

openapi: 3.2.0
info:
  title: Patsnap Open Platform AI Translation Drug Visual Analysis API
  version: 1.0.0
  description: OpenAPI specification for Patsnap Open Platform APIs, including patent search, analytics, and Eureka AI capabilities.
servers:
- url: https://connect.patsnap.com
  description: Patsnap Open Platform API gateway
tags:
- name: 'Drug Visual Analysis '
  description: Drug Visual Analysis  APIs.
paths:
  /synapse/bull-eyes-plot:
    post:
      operationId: b057SynapseBullEyesPlot
      summary: B057 Bull eyes plot
      description: Obtain bull eyes plot
      tags:
      - 'Drug Visual Analysis '
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful b057 bull eyes plot response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B057SynapseBullEyesPlotResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/synapse/bull-eyes-plot
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B057SynapseBullEyesPlotRequest'
  /synapse/alert/drug_search/create:
    post:
      operationId: b064-1DrugSearchCreate
      summary: B064-1 Create drug monitoring
      description: Drug monitoring
      tags:
      - 'Drug Visual Analysis '
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful b064-1 create drug monitoring response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B064-1DrugSearchCreateResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/synapse/alert/drug_search/create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B064-1DrugSearchCreateRequest'
  /synapse/alert/drug_search/edit:
    post:
      operationId: b064-2DrugSearchEdit
      summary: B064-2 Edit drug monitoring
      description: Edit drug monitoring
      tags:
      - 'Drug Visual Analysis '
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful b064-2 edit drug monitoring response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B064-2DrugSearchEditResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/synapse/alert/drug_search/edit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B064-2DrugSearchEditRequest'
  /synapse/drug/milestone:
    post:
      operationId: b074DrugMilestone
      summary: B074 Drug milestone
      description: Obtain drug milestone, including milestone, event, disease, country, organization, etc.
      tags:
      - 'Drug Visual Analysis '
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful b074 drug milestone response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B074DrugMilestoneResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/synapse/drug/milestone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B074DrugMilestoneRequest'
  /synapse/alert/drug_search/query:
    post:
      operationId: b064-3DrugSearchQuery
      summary: B064-3 Query drug monitoring
      description: Query drug monitoring
      tags:
      - 'Drug Visual Analysis '
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful b064-3 query drug monitoring response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B064-3DrugSearchQueryResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/synapse/alert/drug_search/query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B064-3DrugSearchQueryRequest'
components:
  schemas:
    B074DrugMilestone_CommonCountry:
      type: object
      properties:
        country_id:
          type: string
          example: 676de5ba-893a-36bb-8683-c93306aaf769
          description: Country/Location ID
        alpha2_code:
          type: string
          example: US
          description: Alpha Code
        display_name:
          type: array
          example:
          - lang: EN
            name: United States
          - lang: CN
            name: 美国
          description: Country/Location Name
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonName'
    B074DrugMilestone_DrugMilestoneResponseDetail:
      type: object
      properties:
        date:
          type: string
          example: '2025-09-09'
          description: Date
        event:
          type: array
          example: 'Please check the form: CommonEntity'
          description: Event
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonEntity'
        country:
          type: array
          example: 'Please check the form: CommonCountry'
          description: Country/Location
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonCountry'
        disease:
          type: array
          example: 'Please check the form: CommonDisease'
          description: Disease
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonDisease'
        description:
          type: array
          example: 'Please check the form: CommonName'
          description: Description
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonName'
        event_status:
          $ref: '#/components/schemas/B074DrugMilestone_CommonEntity'
        organization:
          type: array
          example: 'Please check the form: CommonOrganization'
          description: Organization
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonOrganization'
        milestone_tag:
          type: array
          example: 'Please check the form: CommonName'
          description: Milestone Tag
          items:
            $ref: '#/components/schemas/B074DrugMilestone_CommonName'
    B064-2DrugSearchEdit_Frequency:
      type: object
      properties:
        date:
          type: integer
          format: int32
          example: 1
          description: 'Date setting, when type is WEEKLY: 1-7 (Monday to Sunday); when type is MONTHLY: 1-29 (day of the month); when type is DAILY: this field is invalid'
        type:
          type: string
          example: WEEKLY
          description: 'Frequency type, supports: DAILY (Daily), WEEKLY (Weekly), MONTHLY (Monthly)'
      required:
      - type
    B064-2DrugSearchEdit_Event:
      type: object
      properties:
        name:
          type: string
          example: drug_dev_status
          description: Event name, supports:<p>query_result (Query Result) - Monitor changes in search results</p><p>drug_dev_status (Drug Development Status) - Monitor changes in drug development phases</p><p>special_approval (Special Approval) - Monitor special approval events</p><p>clinical_trial (Clinical Trial) - Monitor clinical trial related events</p><p>drug_deal (Drug Deal) - Monitor drug deal events</p><p>patent (Patent) - Monitor patent related events</p><p>paper (Paper) - Monitor paper publication events</p><p>translational_medicine (Translational Medicine) - Monitor translational medicine events</p><p>news (News) - Monitor news events</p>
        sub_event:
          type: array
          example:
          - DISCOVERY
          - PRECLINICAL
          - PHASE_1
          description: 'Sub-event list, different options for different event types:<p>query_result (Query Result): [QUERY_RESULT (Query Result Change)]</p><p>drug_dev_status (Drug Development Status): [DISCOVERY (Drug Discovery), PRECLINICAL (Preclinical), IND (Investigational New Drug), IND_APPROVAL (IND Approval), EARLY_PHASE_1 (Early Phase 1), PHASE_1 (Phase 1), PHASE_1_2 (Phase 1/2), PHASE_2 (Phase 2), PHASE_2_3 (Phase 2/3), PHASE_3 (Phase 3), NDA_BLA (New Drug Application/Biologics License Application), APPROVED (Approved), DISCONTINUED (Discontinued), WITHDRAWN (Withdrawn), SUSPENDED (Suspended)]</p><p>special_approval (Special Approval): [SPECIAL_APPROVAL (Special Approval Event)]</p><p>clinical_trial (Clinical Trial): [CLINICAL_TRIAL_FIRST_POSTED (Clinical Trial First Posted), CLINICAL_TRIAL_CLINICAL_PROGRESS (Clinical Trial Progress), CLINICAL_TRIAL_RESULT_PUBLISHED (Clinical Trial Result Published)]</p><p>drug_deal (Drug Deal): [ACTIVE (Active), TERMINATED (Terminated), COMPLETED (Completed)]</p><p>patent (Patent): [PATENT_PUBLISHED (Patent Published), PATENT_GRANTED (Patent Granted), PATENT_EXPIRE_WITHIN_FIVE_YEARS (Patent Expire Within 5 Years), PATENT_EXPIRE_WITHIN_THREE_YEARS (Patent Expire Within 3 Years), PATENT_EXTENSION (Patent Extension)]</p><p>paper (Paper): [PAPER (Paper Published)]</p><p>translational_medicine (Translational Medicine): [TRANSLATIONAL_MEDICINE (Translational Medicine Event)]</p><p>news (News): [NEWS (News Event)]</p>'
      required:
      - name
      - sub_event
    B064-1DrugSearchCreate_DrugSearchDiseaseConditionValue:
      type: object
      properties:
        condition:
          type: string
          example: OR
          description: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
        value:
          type: array
          example:
          - 3beea980d93a4cc0abc864e27514601c
          description: Value List
    B064-3DrugSearchQueryRequest:
      type: object
      properties:
        alert_id:
          type: string
          example: 7b594e7d-34e1-43e6-9674-6ef8c242b721
          description: Alert ID, obtained through create alert interface
      required:
      - alert_id
    B057SynapseBullEyesPlot_CommonConditionValue2:
      type: object
      properties:
        condition:
          type: string
          example: OR
          description: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
        value:
          type: array
          example:
          - 2838b95ade834c96b17ac8bcd2b68c27
          description: Value List
    B064-3DrugSearchQuery_DrugTypeEntity:
      type: object
      properties:
        dict_id:
          type: string
          example: e24259c0e9fe439b8b8fb5985182a517
          description: Dictionary ID
        display_name_cn:
          type: string
          example: mRNA疫苗
          description: Chinese display name
        display_name_en:
          type: string
          example: mRNA vaccine
          description: English display name
    B064-2DrugSearchEdit_DrugSearchRequestDto:
      type: object
      properties:
        offset:
          type: integer
          format: int64
          example: 0
          description: Offset, default 0
        limit:
          type: integer
          format: int64
          example: 10
          description: Limit, default 10. offset + limit <= 10000， limit up to 1,000.
        drug:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchDrugConditionValue'
        target:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchTargetConditionValue'
        disease:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchDiseaseConditionValue'
        organization:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchOrganizationConditionValue'
        mechanism_action:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchMechanismActionConditionValue'
        drug_type:
          $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchDrugTypeConditionValue'
        global_highest_dev_status:
          type: array
          example:
          - Approved
          description: 'Drug Highest Phase. The value is an enum with the following values: 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:
          type: boolean
          example: true
          description: Whether Drug Deal Exist
        dev_status:
          type: array
          example:
          - Approved
          description: 'Phase(By Indication). The value is an enum with the following values: 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:
          type: array
          example:
          - US
          - EU
          description: 'Phase(By Indication). The value is an enum with the following values: US, EU, JP, CN, Other'
        organization_type:
          type: array
          example:
          - Company
          description: 'Organization Type. The value is an enum with the following values: Company, University_Institution, Other'
        employee_number:
          type: array
          example:
          - GREATER_THAN_500
          description: 'Employee Number. The value is an enum with the following values: LESS_THAN_10, BETWEEN_10_AND_100, BETWEEN_100_AND_500, GREATER_THAN_500'
        start_up:
          type: boolean
          example: false
          description: Whether Start-Up Organization
        sort:
          type: array
          example:
          - sort_field: DRUG_TYPE_SORT
            sort_order: desc
          - sort_field: GLOBAL_HIGHEST_DEV_STATUS_RANK
            sort_order: desc
          - sort_field: FIRST_APPROVED_DATE
            sort_order: desc
          description: 'Field order, field can support: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE; order can support:desc, asc (default desc)'
          items:
            $ref: '#/components/schemas/B064-2DrugSearchEdit_DrugSearchSortDto'
    B057SynapseBullEyesPlot_BullEyesStatInfoDto:
      type: object
      properties:
        drug_type:
          type: array
          example:
          - display_name:
            - lang: EN
              name: Biological products
            - lang: CN
              name: 生物药
            normalized_id: 06bc75afc2f44364a9663730fa37c37a
          description: Drug Type, Referencing "CommonDictionary"
          items:
            $ref: '#/components/schemas/B057SynapseBullEyesPlot_CommonDictionary'
    B064-3DrugSearchQuery_RegionEntity:
      type: object
      properties:
        region_id:
          type: string
          example: US
          description: Region ID
        display_name_cn:
          type: string
          example: 美国
          description: Chinese display name
        display_name_en:
          type: string
          example: United States
          description: English display name
    B064-3DrugSearchQuery_SpecialApprovalAlert:
      type: object
      properties:
        uuid:
          type: string
          example: uuid_123456789
          description: Unique identifier
        country:
          type: string
          example: US
          description: Country
        drug_id:
          type: string
          example: drug_123456
          description: Drug ID
        drug_type:
          type: array
          example:
          - small_molecule
          description: Drug type ID list
        target_id:
          type: string
          example: target_001
          description: Target ID
        disease_id:
          type: string
          example: disease_001
          description: Disease ID
        data_source:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DataSource'
        country_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_RegionEntity'
        drug_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DrugEntity'
        event_type_cn:
          type: string
          example: 特殊审批
          description: Event type Chinese
        event_type_en:
          type: string
          example: Special Approval
          description: Event type English
        drug_type_view:
          type: array
          example:
          - dictId: small_molecule
            displayNameCn: 小分子药物
            displayNameEn: Small Molecule
          description: Drug type details list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_DrugTypeEntity'
        special_review:
          type: string
          example: fast_track
          description: Special review
        target_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_TargetEntity'
        disease_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DiseaseEntity'
        organization_id:
          type: string
          example: org_001
          description: Organization ID
        special_review_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_SpecialReviewEntity'
        organization_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_OrganizationEntity'
    B064-2DrugSearchEdit_DrugSearchDrugConditionValue:
      type: object
      properties:
        condition:
          type: string
          example: OR
          description: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
        value:
          type: array
          example:
          - 945fa31ebe9e41ae912e493aa3324576
          description: Value List
    B064-2DrugSearchEdit_DrugSearchOrganizationConditionValue:
      type: object
      properties:
        condition:
          type: string
          example: OR
          description: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
        value:
          type: array
          example:
          - 6a8c172f1efc649035845f94c31a9c1e
          description: Value List
    B057SynapseBullEyesPlot_BullEyesPlotDrugDataDto:
      type: object
      properties:
        drug_id:
          type: string
          example: e82b83b42eba4e5ea3f26f8e06081a5a
          description: Drug ID
        drug_type:
          $ref: '#/components/schemas/B057SynapseBullEyesPlot_CommonDictionary'
        display_name:
          type: array
          example:
          - lang: EN
            name: Ranibizumab (Genentech)
          - lang: CN
            name: 雷珠单抗
          description: Drug Name, Referencing "CommonName"
          items:
            $ref: '#/components/schemas/B057SynapseBullEyesPlot_CommonName'
    B064-3DrugSearchQuery_ClinicalTrialAlert:
      type: object
      properties:
        phase:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DevStatusEntity'
        title:
          type: string
          example: Phase II Study of Drug X in Cancer Patients
          description: Trial title
        event_type_cn:
          type: string
          example: 临床试验
          description: Event type Chinese
        event_type_en:
          type: string
          example: Clinical Trial
          description: Event type English
        register_number:
          type: string
          example: NCT12345678
          description: Register number
        clinical_trial_id:
          type: string
          example: ct_123456
          description: Clinical trial ID
        clinical_result_id:
          type: string
          example: result_123456
          description: Clinical result ID
        org_master_entity_id:
          type: array
          example:
          - org_001
          - org_002
          description: Organization master entity ID list
        org_master_entity_id_view:
          type: array
          example:
          - entityId: org_001
            displayNameCn: 辉瑞制药
            displayNameEn: Pfizer Inc.
          - entityId: org_002
            displayNameCn: 罗氏制药
            displayNameEn: Roche
          description: Organization details list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_OrganizationEntity'
        clinical_result_register_number:
          type: array
          example:
          - registerNumber: NCT12345678
            clinicalTrialId: ct_123456
          - registerNumber: NCT87654321
            clinicalTrialId: ct_789012
          description: Clinical result register number list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_ClinicalResultRegisterNumber'
    B064-3DrugSearchQuery_DiseaseEntity:
      type: object
      properties:
        disease_id:
          type: string
          example: f7ea24f0370d421480503e720310bf86
          description: Disease ID
        display_name_cn:
          type: string
          example: 食管癌
          description: Chinese display name
        display_name_en:
          type: string
          example: Esophageal Carcinoma
          description: English display name
    B064-3DrugSearchQuery_DevStatusAlert:
      type: object
      properties:
        country:
          type: string
          example: US
          description: Country
        drug_id:
          type: string
          example: drug_123456
          description: Drug ID
        drug_type:
          type: array
          example:
          - small_molecule
          description: Drug type ID list
        target_id:
          type: string
          example: target_001
          description: Target ID
        dev_status:
          type: string
          example: phase_ii
          description: Development status
        disease_id:
          type: string
          example: disease_001
          description: Disease ID
        data_source:
          type: array
          example:
          - name: FDA
            displayNameCn: 美国食品药品监督管理局
            displayNameEn: Food and Drug Administration
          description: Data source list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_DataSource'
        country_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_RegionEntity'
        drug_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DrugEntity'
        event_type_cn:
          type: string
          example: 临床试验进展
          description: Event type Chinese
        event_type_en:
          type: string
          example: Clinical Trial Progress
          description: Event type English
        drug_type_view:
          type: array
          example:
          - dictId: small_molecule
            displayNameCn: 小分子药物
            displayNameEn: Small Molecule
          description: Drug type details list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_DrugTypeEntity'
        target_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_TargetEntity'
        disease_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_DiseaseEntity'
        organization_id:
          type: string
          example: org_001
          description: Organization ID
        organization_id_view:
          $ref: '#/components/schemas/B064-3DrugSearchQuery_OrganizationEntity'
    B064-3DrugSearchQuery_TargetEntity:
      type: object
      properties:
        target_id:
          type: string
          example: 2127d2d1ce6736a8be550cf37f0c1c63
          description: Target ID
        display_name_cn:
          type: string
          example: 细胞程序性死亡-1
          description: Chinese display name
        display_name_en:
          type: string
          example: Programmed cell death protein 1
          description: English display name
    B064-1DrugSearchCreate_DrugSearchTargetConditionValue:
      type: object
      properties:
        condition:
          type: string
          example: OR
          description: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
        value:
          type: array
          example:
          - 9786d32e3d244a688ec6a60d2fe1b10b
          description: Value List
    B064-3DrugSearchQuery_OrganizationEntity:
      type: object
      properties:
        entity_id:
          type: string
          example: ca22cc385c771846b24b6df608005a9a
          description: Entity ID
        display_name_cn:
          type: string
          example: 华东师范大学
          description: Chinese display name
        display_name_en:
          type: string
          example: East China Normal University
          description: English display name
    B064-3DrugSearchQuery_TranslationalMedicineAlert:
      type: object
      properties:
        title:
          type: string
          example: Novel Biomarker Discovery in Cancer Research
          description: Title
        journal_id:
          type: array
          example:
          - journal_001
          - journal_002
          description: Journal ID list
        source_url:
          type: string
          example: https://example.com/source/123456
          description: Source URL
        event_time_cn:
          type: string
          example: 2024年1月15日
          description: Event time Chinese
        event_time_en:
          type: string
          example: January 15, 2024
          description: Event time English
        journal_id_view:
          type: array
          example:
          - dictId: nature_medicine
            displayNameCn: 自然医学
            displayNameEn: Nature Medicine
          - dictId: science
            displayNameCn: 科学
            displayNameEn: Science
          description: Journal details list
          items:
            $ref: '#/components/schemas/B064-3DrugSearchQuery_JournalEntity'
        translational_medicine_id:
          type: string
          example: tm_123456
          description: Translational medicine ID
    B074DrugMilestone_CommonName:
      type: object
      properties:
        lang:
          type: string
          example: EN
          description: Language
        name:
          type: string
          example: Ranibizumab (Genentech)
          description: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    B064-1DrugSearchCreateRequest:
      type: object
      properties:
        events:
          type: array
          example:
          - name: query_result
            subEvent:
            - QUERY_RESULT
          - name: drug_dev_status
            subEvent:
            - DISCOVERY
            - PRECLINICAL
            - PHASE_1
            - APPROVED
          - name: clinical_trial
            subEvent:
            - CLINICAL_TRIAL_FIRST_POSTED
            - CLINICAL_TRIAL_RESULT_PUBLISHED
          - name: patent
            subEvent:
            - PATENT_PUBLISHED
            - PATENT_GRANTED
          description: Event subscription list
          items:
            $ref: '#/components/schemas/B064-1DrugSearchCreate_Event'
        frequency:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_Frequency'
        lang:
          type: string
          example: CN
          description: 'Language setting, supports: CN (Chinese), EN (English)'
        query:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchRequestDto'
        title:
          type: string
          example: 我的药物预警
          description: Alert title
      required:
      - events
      - frequency
      - lang
      - query
      - title
    B064-1DrugSearchCreate_DrugSearchRequestDto:
      type: object
      properties:
        offset:
          type: integer
          format: int64
          example: 0
          description: Offset, default 0
        limit:
          type: integer
          format: int64
          example: 10
          description: Limit, default 10. offset + limit <= 10000， limit up to 1,000.
        drug:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchDrugConditionValue'
        target:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchTargetConditionValue'
        disease:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchDiseaseConditionValue'
        organization:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchOrganizationConditionValue'
        mechanism_action:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchMechanismActionConditionValue'
        drug_type:
          $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchDrugTypeConditionValue'
        global_highest_dev_status:
          type: array
          example:
          - Approved
          description: 'Drug Highest Phase. The value is an enum with the following values: 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:
          type: boolean
          example: true
          description: Whether Drug Deal Exist
        dev_status:
          type: array
          example:
          - Approved
          description: 'Phase(By Indication). The value is an enum with the following values: 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:
          type: array
          example:
          - US
          - EU
          description: 'Phase(By Indication). The value is an enum with the following values: US, EU, JP, CN, Other'
        organization_type:
          type: array
          example:
          - Company
          description: 'Organization Type. The value is an enum with the following values: Company, University_Institution, Other'
        employee_number:
          type: array
          example:
          - GREATER_THAN_500
          description: 'Employee Number. The value is an enum with the following values: LESS_THAN_10, BETWEEN_10_AND_100, BETWEEN_100_AND_500, GREATER_THAN_500'
        start_up:
          type: boolean
          example: false
          description: Whether Start-Up Organization
        sort:
          type: array
          example:
          - sort_field: DRUG_TYPE_SORT
            sort_order: desc
          - sort_field: GLOBAL_HIGHEST_DEV_STATUS_RANK
            sort_order: desc
          - sort_field: FIRST_APPROVED_DATE
            sort_order: desc
          description: 'Field order, field can support: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE; order can support:desc, asc (default desc)'
          items:
            $ref: '#/components/schemas/B064-1DrugSearchCreate_DrugSearchSortDto'
    B057SynapseBullEyesPlot_CommonCountry:
      type: object
      properties:
        country_id:
          type: string
          example: 676de5ba-893a-36bb-8683-c93306aaf769
          description: Country/Location ID
        alpha2_code:
          type: string
       

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/patsnap/refs/heads/main/openapi/patsnap-drug-visual-analysis-api-openapi.yml