Sign in
ALERTS_V1

Evaluate

Evaluate a rule. dry_run=True for read-only, False to record the run.

post/api/v1/alerts/rules/{rule_id}/evaluate

Path parameters

rule_idinteger required

Request body

dry_runboolean

Response

Successful Response

display_contextobject nullable
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)

Changes

Changed in 1 of the 55 revisions of this API.1

  • eebfc2f234e11See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 68 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog