---
title: "B064-1 Create drug monitoring"
method: POST
path: "/synapse/alert/drug_search/create"
tags: ["Drug Visual Analysis "]
---

# B064-1 Create drug monitoring

`POST /synapse/alert/drug_search/create`

## Request

- Base URL: `https://connect.patsnap.com`
- URL: `https://connect.patsnap.com/synapse/alert/drug_search/create`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/docs/synapse/alert/drug_search/create/post.ts> (a function with typed inputs; its response is checked against the schema)

Drug monitoring

## Request body

- B0641DrugSearchCreateRequest
  - `events` B0641DrugSearchCreateEvent[], required: Event subscription list
    - `name` string, required: 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` unknown[], required: 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>
      - unknown
  - `frequency` B0641DrugSearchCreateFrequency, required
    - `date` integer: 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` string, required: Frequency type, supports: DAILY (Daily), WEEKLY (Weekly), MONTHLY (Monthly)
  - `lang` string, required: Language setting, supports: CN (Chinese), EN (English)
  - `query` B0641DrugSearchCreateDrugSearchRequestDto, required
    - `offset` integer: Offset, default 0
    - `limit` integer: Limit, default 10. offset + limit <= 10000， limit up to 1,000.
    - `drug` B0641DrugSearchCreateDrugSearchDrugConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `target` B0641DrugSearchCreateDrugSearchTargetConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `disease` B0641DrugSearchCreateDrugSearchDiseaseConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `organization` B0641DrugSearchCreateDrugSearchOrganizationConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `mechanism_action` B0641DrugSearchCreateDrugSearchMechanismActionConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `drug_type` B0641DrugSearchCreateDrugSearchDrugTypeConditionValue
      - `condition` string: Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
      - `value` unknown[]: Value List
        - unknown
    - `global_highest_dev_status` unknown[]: 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.
      - unknown
    - `exist_deal` boolean: Whether Drug Deal Exist
    - `dev_status` unknown[]: 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.
      - unknown
    - `country` unknown[]: Phase(By Indication). The value is an enum with the following values: US, EU, JP, CN, Other
      - unknown
    - `organization_type` unknown[]: Organization Type. The value is an enum with the following values: Company, University_Institution, Other
      - unknown
    - `employee_number` unknown[]: 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
      - unknown
    - `start_up` boolean: Whether Start-Up Organization
    - `sort` B0641DrugSearchCreateDrugSearchSortDto[]: Field order, field can support: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE; order can support:desc, asc (default desc)
      - `sort_field` string: sort field, enum values: DRUG_TYPE_SORT, GLOBAL_HIGHEST_DEV_STATUS_RANK, FIRST_APPROVED_DATE
      - `sort_order` string: sort order, support:desc,asc
  - `title` string, required: Alert title

## Response `200`

Successful b064-1 create drug monitoring response.

- B0641DrugSearchCreateResponse
  - `data` B0641DrugSearchCreateAlertResponse
    - `alert_id` string: Alert ID
  - `status` boolean, required: Status
  - `error_msg` string: Error Message
  - `error_code` integer, required: Error Code

## Other responses

- `201`: Created.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not Found.

---

[API](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api.md) - [All operations](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/revisions/c2264a0de595?raw)