Conversation Monitor Evaluation

REST API Reference

A QA monitor evaluation of this conversation. Returned in the monitor_evaluations array on conversation responses when include_monitors=true is passed.

monitor_idstring

The unique identifier of the monitor that produced this evaluation.

Example:"12345"

monitor_namestring or null

The name of the monitor at the time of evaluation. Null if the monitor has since been deleted.

Example:"Customer complaint handling"

monitor_typestring or null

The type of the monitor. Null if the monitor has since been deleted.

Example:"prompt"

resultstring

The evaluation outcome reported by the monitor: included (the conversation matches the monitor's criteria), excluded, error or awaiting_async_data.

Example:"included"

explanationstring or null

The reasoning provided by the monitor for its result. May be null if no reasoning was generated.

Example:"The customer mentioned wanting a refund without resolution."

evaluated_atinteger or null, (date-time)

The time the monitor evaluated this conversation. Null in the rare case the underlying record's timestamp is not yet set.

Example:1719493065

{
  "monitor_id": "12345",
  "monitor_name": "Customer complaint handling",
  "monitor_type": "prompt",
  "result": "included",
  "explanation": "The customer mentioned wanting a refund without resolution.",
  "evaluated_at": 1719493065
}