JavaScript
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.benchmark.getTarget('targetKey', { suite: 'x' });
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.benchmark.get_target(
target_key="targetKey",
suite="x",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/benchmark/target/{targetKey} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/benchmark/target/{targetKey}",
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/benchmark/target/{targetKey}"
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/benchmark/target/{targetKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/benchmark/target/{targetKey}")
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": {
"target": {
"targetKey": "<string>",
"targetName": "<string>",
"suite": "<string>",
"suiteVersion": "<string>",
"publicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"iterations": 123,
"sampleCallCount": 123,
"publishedAt": "<string>",
"supersededAt": "<string>",
"isCurrent": true
},
"results": [
{
"conditionKey": "<string>",
"conditionLabel": "<string>",
"metricKey": "<string>",
"metricName": "<string>",
"metricKind": "NUMERIC",
"unitSymbol": "<string>",
"n": 123,
"p50": 123,
"p95": 123,
"mean": 123,
"ciLow": 123,
"ciHigh": 123,
"passRate": 123,
"passRateCiLow": 123,
"passRateCiHigh": 123
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}Benchmark
Get a benchmark target
Returns a target’s published sweep and every one of its aggregate cells: the overall rollup plus a set per condition. Defaults to the current sweep; pass publicationId from the history endpoint to read a superseded one, which is how a regression is compared generation to generation. Numbers only — no transcript and no audio.
GET
/
v1
/
benchmark
/
target
/
{targetKey}
JavaScript
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.benchmark.getTarget('targetKey', { suite: 'x' });
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.benchmark.get_target(
target_key="targetKey",
suite="x",
)
print(response.data)curl --request GET \
--url https://api.roark.ai/v1/benchmark/target/{targetKey} \
--header 'Authorization: Bearer <token>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.roark.ai/v1/benchmark/target/{targetKey}",
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/benchmark/target/{targetKey}"
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/benchmark/target/{targetKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roark.ai/v1/benchmark/target/{targetKey}")
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": {
"target": {
"targetKey": "<string>",
"targetName": "<string>",
"suite": "<string>",
"suiteVersion": "<string>",
"publicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"iterations": 123,
"sampleCallCount": 123,
"publishedAt": "<string>",
"supersededAt": "<string>",
"isCurrent": true
},
"results": [
{
"conditionKey": "<string>",
"conditionLabel": "<string>",
"metricKey": "<string>",
"metricName": "<string>",
"metricKind": "NUMERIC",
"unitSymbol": "<string>",
"n": 123,
"p50": 123,
"p95": 123,
"mean": 123,
"ciLow": 123,
"ciHigh": 123,
"passRate": 123,
"passRateCiLow": 123,
"passRateCiHigh": 123
}
]
}
}{
"type": "validation",
"code": "invalid_parameter",
"message": "The request was invalid",
"param": "email"
}{
"type": "authentication",
"code": "unauthorized",
"message": "Authentication required"
}{
"type": "not_found",
"code": "resource_not_found",
"message": "The requested resource could not be found"
}{
"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
Minimum string length:
1Minimum string length:
1Response
The target and all of its published cells
Show child attributes
Show child attributes