alerts

Test Alert

Test an alert rule (dry run) to see if it would trigger.

post/api/v1/alerts/{alert_id}/test

Request

  • Base URL: https://geo.sig.ai (the document declares no server; this is the origin it was published from)
  • URL: https://geo.sig.ai/api/v1/alerts/{alert_id}/test
  • Auth: HTTP bearer

Path parameters

alert_idstring uuid required

Cookies

access_tokenstring nullable

Request body

conditionsobject required

Conditions to test

channelsobject[] required

Channels to simulate

Response

Successful Response

would_triggerboolean required

Whether alert would trigger

trigger_reasonstring nullable

Why alert would/wouldn't trigger

matched_dataobject nullable

Data that matched conditions

channel_validationobject[] required

Channel validation results

Changes

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