API Reference

Detectors

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Evaluate rules against an event

detectors.evaluate(strdetector_id, DetectorEvaluateParams**kwargs) -> DetectorEvaluateResponse

POST/api/detectors/{detectorId}/evaluate

Evaluate rules against an event

ParametersExpand Collapse

detector_id: str

event: Event

fields: Dict[str, object]

timestamp_ms: float

context: Optional[Context]

vars: Optional[Dict[str, object]]

ReturnsExpand Collapse

class DetectorEvaluateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

messages: List[Message]

code: int

minimum1000

message: str

result: Result

actions: List[object]

success: bool

Evaluate rules against an event

Python

HTTP

Python

import os
from rake import Rake

client = Rake(
    api_key=os.environ.get("RAKE_API_KEY"),  # This is the default and can be omitted
)
response = client.detectors.evaluate(
    detector_id="detectorId",
    event={
        "fields": {
            "foo": "bar"
        },
        "timestamp_ms": 0,
    },
)
print(response.errors)

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "actions": [
      {}
    ]
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "actions": [
      {}
    ]
  },
  "success": true
}