Skip to content
Get started

Evaluate rules against an event

POST/api/detectors/{detectorId}/evaluate

Evaluate rules against an event

Path ParametersExpand Collapse
detectorId: string
Body ParametersJSONExpand Collapse
event: object { fields, timestamp_ms }
fields: map[unknown]
timestamp_ms: number
context: optional object { vars }
vars: optional map[unknown]
ReturnsExpand Collapse
errors: array of object { code, message }
code: number
minimum1000
message: string
messages: array of object { code, message }
code: number
minimum1000
message: string
result: object { actions }
actions: array of unknown
success: boolean

Evaluate rules against an event

curl https://rake.dev/api/detectors/$DETECTOR_ID/evaluate \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $RAKE_API_KEY" \
    -d '{
          "event": {
            "fields": {
              "foo": "bar"
            },
            "timestamp_ms": 0
          }
        }'
{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "actions": [
      {}
    ]
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "actions": [
      {}
    ]
  },
  "success": true
}