v1

latestOpenAPI 3.1.02026-07-22152755.8 KB

Metrics

Retrieve a metric

Fetch one metric by id.

get/test_framework/v2/metrics/{id}/

Path parameters

idstring required

ID or Slug - Metric identifier. Can be either:

Numeric ID (e.g., 123)
Slug (e.g., latency_metric, customer_satisfaction)

Response

idinteger

slugstring nullable

URL-friendly unique identifier in snake_case format. Example: "customer_satisfaction_1562"

projectinteger nullable

agentsinteger[]

namestring

Name of the metric. Example: "Customer Satisfaction" or "Appointment Booking"

descriptionstring

Description of what the metric measures. Example: "Measures how satisfied customers are with the service provided"

type'basic' | 'custom_prompt' | 'custom_code' | 'llm_judge'

Type of metric

basic - Basic (Deprecated in favor of LLM Judge)
custom_prompt - Custom Prompt ( Deprecated in favor of LLM Judge)
custom_code - Custom Code
llm_judge - LLM Judge

eval_type'binary' | 'continuous_qualitative' | 'numeric' | 'enum'

binary - Binary
continuous_qualitative - Continuous Qualitative
numeric - Numeric
enum - Enum

{"stackTrail":"components:schemas:MetricDetailSerializerV2:properties:enum_values","oasType":"schema","type":"unknown","description":"\nList of possible enum values for enum type metrics.\nExample: `[\"satisfied\", \"unsatisfied\"]`\n"}

audio_enabledboolean

Whether this metric requires audio analysis. Example: true or false

promptstring

Evaluation prompt for the metric. Example: "Evaluate customer satisfaction based on conversation"

evaluation_trigger'always' | 'automatic' | 'custom'

always - Always
automatic - Automatic
custom - Custom

trigger_type'llm_judge' | 'custom_code'

Type of trigger evaluation: LLM judge or custom code. Only used when evaluation_trigger is CUSTOM. Example: "llm_judge" or "custom_code"

llm_judge - LLM Judge
custom_code - Custom Code

evaluation_trigger_promptstring

Evaluation trigger prompt for the metric. Example: "Evaluate metric only if call ended reason is main-agent-ended-call"

evaluation_trigger_custom_codestring

Python custom code to determine metric relevance. Code should set _result (bool) and _explanation (str). Example: