curl --request GET \
--url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/scorecards/scorecard-metrics/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.siro.ai/v1/core/scorecards/scorecard-metrics/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 => [
"x-siro-auth-token: <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.siro.ai/v1/core/scorecards/scorecard-metrics/values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-token", "<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.siro.ai/v1/core/scorecards/scorecard-metrics/values")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"recordingsEvaluatedCount": 150,
"metricValues": [
{
"id": "metric_value_001",
"name": "Conversation Time",
"unit": "seconds",
"unitAbbreviated": "sec",
"metricType": "CONVERSATION_TIME",
"description": "Total duration of the conversation in seconds",
"value": 1800,
"passRate": 123
}
],
"startAt": "2024-01-01T00:00:00Z",
"endAt": "2024-01-31T23:59:59Z",
"filterByIds": [
"user_001",
"user_002"
],
"filterBy": "USER"
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Get scorecard metrics values
Get scorecard metrics values for an organization and conversation typewithin a specified time range and filter criteria. The user must have access to the requested organization.
curl --request GET \
--url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/scorecards/scorecard-metrics/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.siro.ai/v1/core/scorecards/scorecard-metrics/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 => [
"x-siro-auth-token: <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.siro.ai/v1/core/scorecards/scorecard-metrics/values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-token", "<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.siro.ai/v1/core/scorecards/scorecard-metrics/values")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"recordingsEvaluatedCount": 150,
"metricValues": [
{
"id": "metric_value_001",
"name": "Conversation Time",
"unit": "seconds",
"unitAbbreviated": "sec",
"metricType": "CONVERSATION_TIME",
"description": "Total duration of the conversation in seconds",
"value": 1800,
"passRate": 123
}
],
"startAt": "2024-01-01T00:00:00Z",
"endAt": "2024-01-31T23:59:59Z",
"filterByIds": [
"user_001",
"user_002"
],
"filterBy": "USER"
},
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Authorizations
OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: <oauth-access-token>. Not an organization API key.
Query Parameters
ID of the organization to get metrics for
"org_123"
ID of the conversation type to filter by
"conv_type_456"
Start date for the metrics range (ISO 8601 format)
"2024-01-01T00:00:00Z"
End date for the metrics range (ISO 8601 format)
"2024-01-31T23:59:59Z"
IDs to filter by (can be array or single string)
1["user_001", "user_002"]
Entity type to filter by (RECORDING, USER, TEAM, ORGANIZATION)
1The entity type to filter scorecard metrics by
RECORDING, USER, TEAM, ORGANIZATION "USER"
Optional grouping for the metrics
1The entity type to filter scorecard metrics by
RECORDING, USER, TEAM, ORGANIZATION "TEAM"