Get conversation metric output(s)

curl --request GET \
  --url https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id}"

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/conversations/{conversation_id}/metrics/{metric_output_id}', 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/conversations/{conversation_id}/metrics/{metric_output_id}",
  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/conversations/{conversation_id}/metrics/{metric_output_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id}")

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

{
  "metric": {
    "metric_output_id": "01JCQR8Z9PQSTNVWXY12345678",
    "metric_id": "29BlkepvvX19ebbLDB0y6Q",
    "value": 2.35,
    "status": "COMPLETED"
  }
}

Metrics

Get conversation metric output(s)

Retrieve metric output(s) for a conversation by ID. The path segment accepts two ID types and returns different response shapes:

26-char MetricOutput ULID (e.g. 01JCQR8Z9PQSTNVWXY12345678): returns a single metric output as { "metric": {...} }.
22-char Metric definition ID (e.g. 29BlkepvvX19ebbLDB0y6Q): returns every output for that metric on the conversation as { "metric_outputs": [...] }.

Clients should branch on the input ID length they passed.

This endpoint serves monitoring conversations only. To retrieve results for a simulation — including test-metric results from POST /v1/metrics/{metric_id}/test — use GET /v1/simulations/{simulation_id}/metrics/{metric_output_id} instead.

GET

conversations

{conversation_id}

metrics

{metric_output_id}

Get conversation metric output(s)

curl --request GET \
  --url https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id}"

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/conversations/{conversation_id}/metrics/{metric_output_id}', 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/conversations/{conversation_id}/metrics/{metric_output_id}",
  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/conversations/{conversation_id}/metrics/{metric_output_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/conversations/{conversation_id}/metrics/{metric_output_id}")

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

{
  "metric": {
    "metric_output_id": "01JCQR8Z9PQSTNVWXY12345678",
    "metric_id": "29BlkepvvX19ebbLDB0y6Q",
    "value": 2.35,
    "status": "COMPLETED"
  }
}

Authorizations

X-API-Key

string

header

required

API key for authentication.

Path Parameters

conversation_id

string

required

Unique conversation identifier

Required string length: 22 - 26

metric_output_id

string

required

Either a 26-char MetricOutput ULID or a 22-char Metric definition ID. See endpoint description for response shape per ID type.

Required string length: 22 - 26

Response

Metric output details. Single object when called with a 26-char ULID, collection object when called with a 22-char metric_id.

Option 1
Option 2

metric

object

required

Single metric output (returned when {metric_output_id} is a 26-char ULID)

Show child attributes

⌘I

API

Runs

Simulations

Conversations

Agents

Mutations

Test Sets

Test Cases

Personas

Metrics

Run Templates

Scheduled Runs

Reviews

Dashboards

Alerts

Reports

Tags

Webhooks

Traces

Conversations Config

API Keys

Integrations

Get conversation metric output(s)

Authorizations

Path Parameters

Response