SAsanctionskit
Monitoring

List meaningful changes, failures and reviews that must be renewed

Required API key scope: results:read.

get/monitoring/inbox

Request

Query parameters

limitinteger

Maximum number of items to return. A response may contain fewer items; use its next cursor to decide whether another page exists.

cursorstring uuid

Pass nextCursor from the previous page; omit for the first page. Continue until the response cursor is null. Keep the same filters between pages.

status'all' | 'unread' | 'acknowledged'

Filter unread or acknowledged monitoring events; omission is all.

kind'initial_match' | 'match_added' | 'match_removed' | 'evidence_changed' | 'policy_changed' | 'baseline_unavailable' | 'screening_failed' | 'screening_overdue' | 'screening_recovered' | 'review_required'

Filter by monitoring event kind. Omit to include every kind.

monitorIdstring uuid

Return only items belonging to this monitor UUID.

Response

Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

Changes

No recorded changes to this operation across all 1 revision of this API.