curl --request GET \
--url https://api.coval.dev/v1/conversations/uploaded/{conversation_id}/metrics/{metric_output_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/conversations/uploaded/{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/uploaded/{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/uploaded/{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/uploaded/{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))
}HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/conversations/uploaded/{conversation_id}/metrics/{metric_output_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/conversations/uploaded/{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"
}
}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 uploaded conversations only. To retrieve
results for a simulation — including test-metric results from
POST /v1/metrics/{metric_id}/test — use
GET /v1/conversations/simulated/{simulation_id}/metrics/{metric_output_id} instead.
curl --request GET \
--url https://api.coval.dev/v1/conversations/uploaded/{conversation_id}/metrics/{metric_output_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/conversations/uploaded/{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/uploaded/{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/uploaded/{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/uploaded/{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))
}HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/conversations/uploaded/{conversation_id}/metrics/{metric_output_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/conversations/uploaded/{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
API key for authentication.
Path Parameters
Unique conversation identifier
22 - 26Either a 26-char MetricOutput ULID or a 22-char Metric definition ID. See endpoint description for response shape per ID type.
22 - 26Response
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
Single metric output (returned when {metric_output_id} is a 26-char ULID)
Show child attributes
Show child attributes
Was this page helpful?