Get available scorecard metrics
curl --request GET \
--url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available"
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/available', 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/available",
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/available"
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/available")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available")
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": {
"scorecardMetrics": [
{
"id": "metric_001",
"name": "Conversation Time",
"unit": "seconds",
"unitAbbreviated": "sec",
"metricType": "CONVERSATION_TIME",
"description": "Total duration of the conversation in seconds",
"llmPrompt": "Analyze the conversation duration and provide insights"
}
]
},
"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>"
}Scorecards
Get available scorecard metrics
Get available scorecard metrics for an organization, conversation type, organization group, or all metrics (Siro admin only).The user must have appropriate access to the requested scope.
GET
/
v1
/
core
/
scorecards
/
scorecard-metrics
/
available
Get available scorecard metrics
curl --request GET \
--url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available"
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/available', 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/available",
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/available"
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/available")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available")
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": {
"scorecardMetrics": [
{
"id": "metric_001",
"name": "Conversation Time",
"unit": "seconds",
"unitAbbreviated": "sec",
"metricType": "CONVERSATION_TIME",
"description": "Total duration of the conversation in seconds",
"llmPrompt": "Analyze the conversation duration and provide insights"
}
]
},
"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
Access token from POST https://auth.siro.ai/oauth2/token (client_credentials), or a Siro OAuth access token. Send x-siro-auth-token: <access-token>.