Get metric values produced by a metric collection job
Returns the metric values produced by the specified job, grouped by metric definition. Unlike GET /v1/call/:callId/metrics (which returns the latest values on a call, regardless of which job computed them), this endpoint returns exactly the values this job produced — including for calls whose live values have since been overwritten by a later job. By default returns only SUCCESS rows; pass ?status=all to also include NOT_APPLICABLE / DATA_MISSING / ERROR.
curl --request GET \
--url https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values', 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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"metricDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"metricId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "COUNT",
"scope": "GLOBAL",
"values": [
{
"captureStatus": "SUCCESS",
"context": "CALL",
"computedAt": "2023-11-07T05:31:56Z",
"value": 123,
"callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errorMessage": "<string>",
"participantRole": "agent",
"valueReasoning": "<string>",
"confidence": 0.5,
"policyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"segment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
},
"fromSegment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
},
"toSegment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
}
}
],
"unit": {
"name": "<string>",
"symbol": "<string>"
}
}
]
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "rate_limit",
"code": "too_many_requests",
"message": "Rate limit exceeded"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Filter metrics by capture status. success (default) returns only successfully computed metrics; all also returns NOT_APPLICABLE / DATA_MISSING / ERROR rows with the value field omitted.
success, all Response
Metric values produced by the job, grouped by metric definition
Metric values produced by a specific metric collection job. Grouped by metric definition, same shape as the per-call metrics endpoint.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values', 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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/metric/collection-jobs/{jobId}/metric-values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"metricDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"metricId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "COUNT",
"scope": "GLOBAL",
"values": [
{
"captureStatus": "SUCCESS",
"context": "CALL",
"computedAt": "2023-11-07T05:31:56Z",
"value": 123,
"callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"errorMessage": "<string>",
"participantRole": "agent",
"valueReasoning": "<string>",
"confidence": 0.5,
"policyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"segment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
},
"fromSegment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
},
"toSegment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"startOffsetMs": 123,
"endOffsetMs": 123
}
}
],
"unit": {
"name": "<string>",
"symbol": "<string>"
}
}
]
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "rate_limit",
"code": "too_many_requests",
"message": "Rate limit exceeded"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}