Skip to main content
GET
/
metrics
List metrics
curl --request GET \
  --url https://api.coval.dev/v1/metrics \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coval.dev/v1/metrics"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coval.dev/v1/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coval.dev/v1/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coval.dev/v1/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/metrics")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "metrics": [
    {
      "name": "metrics/abc123def456ghi789jklm",
      "id": "abc123def456ghi789jklm",
      "metric_name": "Customer Satisfaction",
      "description": "Evaluates customer satisfaction",
      "prompt": "Did the agent resolve the issue?",
      "categories": [
        "positive",
        "neutral",
        "negative"
      ],
      "min_value": 1,
      "max_value": 10,
      "metadata_field_key": "satisfaction_score",
      "regex_pattern": "(hello|hi)",
      "role": "agent",
      "min_pause_duration_seconds": 0.5,
      "include_traces": true,
      "runtime_config": {
        "model_version": "openai:gpt-4.1-mini-2025-04-14",
        "thinking_enabled": true
      },
      "target_condition": {
        "comparison_operator": "in",
        "target_values": [
          "YES"
        ]
      },
      "tags": [
        "production",
        "llm"
      ],
      "created_by": "<string>",
      "create_time": "2023-11-07T05:31:56Z",
      "update_time": "2023-11-07T05:31:56Z",
      "current_version": {
        "ulid": "01KKWQYSF737ZN6X1Q1RYX8M2D",
        "version_number": 3
      }
    }
  ],
  "next_page_token": "<string>"
}
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Authentication failed",
    "details": [
      {
        "field": "X-API-Key",
        "description": "Invalid or missing API key"
      }
    ]
  }
}
{
  "error": {
    "code": "INTERNAL",
    "message": "Internal server error"
  }
}

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.

tag_filters
string[]

Filter metrics by tags. A resource matches when it has ALL the listed tags (AND-semantics).

Repeat the parameter for each tag (e.g., ?tag_filters=production&tag_filters=llm).

Maximum array length: 20

Response

Successful response

metrics
object[]
required
next_page_token
string | null