v5

latestOpenAPI 3.1.02026-08-081,0211,3082.1 MB

ALERTS_V1

Dry Run

Evaluate a rule config on-the-fly without persisting anything.

Accepts the same JSON shape as RuleCreateRequest / the saved column, so the payload can be copy-pasted directly.

post/api/v1/alerts/dry-run

Request body

namestring nullable

rule_typestring nullable

platformstring nullable

entity_typestring required

deliveryobject nullable

Ignored for evaluation; accepted so full rule JSON can be pasted.

reference_timestring date-time nullable

Evaluate as if 'now' were this timestamp (ISO-8601). Defaults to UTC now.

Response

Successful Response

run_idstring nullable

rule_idinteger nullable

metric_namestring required

current_valuenumber required

previous_valuenumber nullable

changenumber nullable

change_percentnumber nullable

threshold_breachedboolean required

statusstring required

errorstring nullable

executed_atstring date-time required

breaching_entitiesobject[] nullable

For per-entity ('ANY') rules: the warehouses that breached, each {entity, current_value, previous_value, change, change_percent}, worst first. Null for ordinary rules.

requestobject nullable

Echo of the resolved request config (dry-run only)