post https://sandbox1-api.unit21.com/v1/alerts/list
Returns an array of top-level information about alerts in your environment.
Because the response is paginated, the request body has a limit and offset field. At least one must be filled.
limitindicates how many objects the request returns (the page maximum is 50)offsetindicates the offset for pagination. Anoffsetvalue of 1 starts with the environment's first record.
To narrow down your alert search, we provide filter parameters to this endpoint. Note that all list inputs function as an "or" filter, as in any one of the values must match the selected alert(s):
| Field | Type | Description |
|---|---|---|
case_id | Numeric | Only alerts with the associated case ID will be shown. |
types | String[] | Must be list of alert types: tm, kyc, chainalysis, car, or manual` |
created_after | Numeric | Alerts created on or after this unix timestamp |
created_before | Numeric | Alerts created before this unix timestamp |
dispositions | String[] | List of alert disposition states (defined on an integration basis) |
dispositioned_after | Numeric | Alerts with a disposition most recently updated after this unix timestamp |
dispositioned_before | Numeric | Alerts with a disposition most recently updated before this unix timestamp |
dispositioned_by | String[] | List of agent emails. Returns alerts with a disposition most recently changed by agents in the list |
rules | Numeric[] | List of Unit21 rule ids that are associated with the alert |
associated_entities | String[] | List of entity ids associated with this alert |
associated_events | String[] | List of event ids associated with this alert |
associated_instruments | String[] | List of instrument ids associated with this alert |
sources | String[] | Must be list of alert sources: INTERNAL, EXTERNAL |
statuses | String[] | Must be list of alert statuses: OPEN, CLOSED |
tag_filters | String[] | List of string tags (key:value) or keys to associate this alert with (e.g. alert_type:high_velocity or alert_type). If only the key is provided, we will match against all tags with that key |
limit | Numeric | A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10 |
offset | Numeric | The offset for pagination. Default is 1 |
options | Object | Options for the data included in the returned alerts. Removing unneeded options can improve response speed |
The total_count field contains the total number of alerts where the response_count field contains the number of alerts included in the response.
Follow the links for more information: