curl --request GET \
--url https://api.coval.dev/v1/metrics/{metric_id} \
--header 'X-API-Key: <api-key>'{
"metric": {
"name": "metrics/abc123def456ghi789jklm",
"id": "abc123def456ghi789jklm",
"metric_name": "Customer Satisfaction",
"description": "Evaluates customer satisfaction",
"metric_type": "METRIC_LLM_BINARY",
"prompt": "Did the agent resolve the issue?",
"categories": [
"positive",
"neutral",
"negative"
],
"min_value": 1,
"max_value": 10,
"metadata_field_type": "STRING",
"metadata_field_key": "satisfaction_score",
"regex_pattern": "(hello|hi)",
"role": "agent",
"min_pause_duration_seconds": 0.5,
"include_traces": true,
"target_condition": {
"comparison_operator": "eq",
"target_float": 123,
"target_values": [
"value1",
"value2"
]
},
"created_by": "<string>",
"create_time": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z"
}
}Retrieve a specific metric by ID.
curl --request GET \
--url https://api.coval.dev/v1/metrics/{metric_id} \
--header 'X-API-Key: <api-key>'{
"metric": {
"name": "metrics/abc123def456ghi789jklm",
"id": "abc123def456ghi789jklm",
"metric_name": "Customer Satisfaction",
"description": "Evaluates customer satisfaction",
"metric_type": "METRIC_LLM_BINARY",
"prompt": "Did the agent resolve the issue?",
"categories": [
"positive",
"neutral",
"negative"
],
"min_value": 1,
"max_value": 10,
"metadata_field_type": "STRING",
"metadata_field_key": "satisfaction_score",
"regex_pattern": "(hello|hi)",
"role": "agent",
"min_pause_duration_seconds": 0.5,
"include_traces": true,
"target_condition": {
"comparison_operator": "eq",
"target_float": 123,
"target_values": [
"value1",
"value2"
]
},
"created_by": "<string>",
"create_time": "2023-11-07T05:31:56Z",
"update_time": "2023-11-07T05:31:56Z"
}
}Was this page helpful?