import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const response = await client.call.listMetrics('callId');
console.log(response.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
response = client.call.list_metrics(
call_id="callId",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/call/{callId}/metrics \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/call/{callId}/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 => [
"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/call/{callId}/metrics"
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/call/{callId}/metrics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/call/{callId}/metrics")
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
},
"evidenceSpans": [
{
"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
},
"reason": "<string>"
}
]
}
],
"unit": {
"name": "<string>",
"symbol": "<string>"
}
}
]
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"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"
}List call metrics
Fetch all call-level metrics for a specific call, including both system-generated and custom metrics. Only returns rows from the latest metric-collection job per metric — if the same metric has been recomputed, prior runs are excluded and remain in the metric history. By default returns only successfully computed metrics; pass ?status=all to also include rows that resolved as NOT_APPLICABLE / DATA_MISSING / ERROR (the value field is omitted on those entries — check captureStatus).
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const response = await client.call.listMetrics('callId');
console.log(response.data);import os
from roark_analytics import Roark
client = Roark(
bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted
)
response = client.call.list_metrics(
call_id="callId",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/call/{callId}/metrics \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/call/{callId}/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 => [
"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/call/{callId}/metrics"
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/call/{callId}/metrics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/call/{callId}/metrics")
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
},
"evidenceSpans": [
{
"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
},
"reason": "<string>"
}
]
}
],
"unit": {
"name": "<string>",
"symbol": "<string>"
}
}
]
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "forbidden",
"code": "permission_denied",
"message": "You do not have permission to access this resource"
}{
"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
Whether to return a flat list instead of grouped by metric definition (default: false)
Filter metrics by capture status. success (default) returns only successfully computed metrics — backwards-compatible with the historical behavior. all also returns NOT_APPLICABLE / DATA_MISSING / ERROR rows (with value omitted), so clients can distinguish "still computing" from "computed but no value" and exit retry loops correctly.
success, all Response
Call-level metrics for a specific call
Conversation metrics response payload grouped by metric definition
Show child attributes
Show child attributes