Skip to main content
GET
/
v1
/
metrics
List metrics
curl --request GET \
  --url https://api.coval.dev/v1/metrics \
  --header 'X-API-Key: <api-key>'
{
  "metrics": [
    {
      "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"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
page_size
integer
default:50

Maximum results per page

Required range: 1 <= x <= 100
​
page_token
string

Pagination token from previous response

​
order_by
string
default:create_time desc

Sort order (e.g., create_time desc, metric_name asc)

​
filter
string

Filter expression syntax. Values may be unquoted or double-quoted. Values containing spaces must be quoted. Example: metric_type=METRIC_LLM_BINARY

​
include_builtin
boolean
default:false

Include built-in metrics in the response. By default, only organization-specific metrics are returned. Set to true to also include Coval's built-in evaluation metrics.

Response

Successful response

​
metrics
object[]
required
​
next_page_token
string | null