alerts

List Alerts

List alerts for the caller's organization with pagination + filters.

policy_set_id, tag and country_code accept comma-separated values and match alerts carrying any of them. date_from/date_to are inclusive calendar dates interpreted in timezone and bound created_at; omitting both lists all time.

limit is capped at 200; requests above that return 422 rather than a silently downgraded response. Iterate through all results using page/limit and the returned total/pages.

Note: offset was removed in favour of page — sending offset has no effect.

get/api/v1/alerts

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/alerts
  • Auth: HTTP bearer

Query parameters

campaign_idstring uuid nullable
status'open' | 'escalated' | 'resolved' | 'dismissed'

Lifecycle status of a policy-violation alert.

policy_set_idstring nullable
tagstring nullable
country_codestring nullable
date_fromstring date nullable
date_tostring date nullable
timezonestring
pageinteger
limitinteger

Response

Successful Response

totalinteger required
pageinteger required
limitinteger required
pagesinteger required

Changes

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