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.metric.updateDefinition('idOrSlug');

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.metric.update_definition(
    id_or_slug="idOrSlug",
)
print(response.data)

curl --request PUT \
  --url https://api.roark.ai/v1/metric/definitions/{idOrSlug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "llmPrompt": "<string>",
  "scaleMin": 50,
  "scaleMax": 50,
  "scaleLabels": [
    {
      "rangeMin": 123,
      "rangeMax": 123,
      "label": "<string>",
      "displayOrder": 123,
      "description": "<string>",
      "colorHex": "<string>"
    }
  ],
  "booleanTrueLabel": "<string>",
  "booleanFalseLabel": "<string>",
  "gradesShortCalls": true,
  "classificationOptions": [
    {
      "label": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "maxClassifications": 2,
  "toolDefinitionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "supportedContexts": [],
  "formula": "<string>",
  "sources": [
    {
      "sourceMetricDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "changeReason": "<string>",
  "slug": "<unknown>",
  "metricId": "<unknown>",
  "source": "<unknown>",
  "organizationId": "<unknown>",
  "projectId": "<unknown>",
  "outputType": "<unknown>",
  "scope": "<unknown>",
  "participantRole": "<unknown>",
  "calcType": "<unknown>",
  "supportsMultipleVariants": "<unknown>",
  "analysisPackageId": "<unknown>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/metric/definitions/{idOrSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'llmPrompt' => '<string>',
    'scaleMin' => 50,
    'scaleMax' => 50,
    'scaleLabels' => [
        [
                'rangeMin' => 123,
                'rangeMax' => 123,
                'label' => '<string>',
                'displayOrder' => 123,
                'description' => '<string>',
                'colorHex' => '<string>'
        ]
    ],
    'booleanTrueLabel' => '<string>',
    'booleanFalseLabel' => '<string>',
    'gradesShortCalls' => true,
    'classificationOptions' => [
        [
                'label' => '<string>',
                'description' => '<string>',
                'displayOrder' => 123
        ]
    ],
    'maxClassifications' => 2,
    'toolDefinitionIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'supportedContexts' => [
        
    ],
    'formula' => '<string>',
    'sources' => [
        [
                'sourceMetricDefinitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'sourceVariantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'changeReason' => '<string>',
    'slug' => '<unknown>',
    'metricId' => '<unknown>',
    'source' => '<unknown>',
    'organizationId' => '<unknown>',
    'projectId' => '<unknown>',
    'outputType' => '<unknown>',
    'scope' => '<unknown>',
    'participantRole' => '<unknown>',
    'calcType' => '<unknown>',
    'supportsMultipleVariants' => '<unknown>',
    'analysisPackageId' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/metric/definitions/{idOrSlug}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.roark.ai/v1/metric/definitions/{idOrSlug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/metric/definitions/{idOrSlug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "metricId": "<string>",
    "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "type": "COUNT",
    "scope": "GLOBAL",
    "supportedContexts": [
      "CALL"
    ],
    "supportedConversationSources": [
      "SIMULATED"
    ],
    "gradesShortCalls": true,
    "requiresLiveConversation": true,
    "supportsVariants": true,
    "evidenceSource": {
      "metricId": "<string>",
      "countsWhen": true
    },
    "calculationType": "LLM_JUDGE",
    "llmPrompt": "<string>",
    "booleanTrueLabel": "<string>",
    "booleanFalseLabel": "<string>",
    "unit": {
      "name": "<string>",
      "symbol": "<string>"
    }
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "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"
}

Metric

Update a metric definition

Update the editable subset of a custom metric definition, addressed by its UUID or its stable slug. Only the supplied fields are changed; omitted fields are left unchanged. Every update creates a new immutable version; the response carries the advanced versionId. Immutable fields (scope, outputType, calcType, …) are rejected, and which fields are editable depends on the metric (e.g. derived metrics only allow name). Roark’s own metrics are rejected here: this endpoint edits the shared definition, which every workspace sees. To change one for your workspace alone, edit its variant with PUT /v1/metric/definitions//variants/, which forks it for you and leaves every other workspace on the original.

PUT

metric

definitions

{idOrSlug}

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.metric.updateDefinition('idOrSlug');

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.metric.update_definition(
    id_or_slug="idOrSlug",
)
print(response.data)

curl --request PUT \
  --url https://api.roark.ai/v1/metric/definitions/{idOrSlug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "llmPrompt": "<string>",
  "scaleMin": 50,
  "scaleMax": 50,
  "scaleLabels": [
    {
      "rangeMin": 123,
      "rangeMax": 123,
      "label": "<string>",
      "displayOrder": 123,
      "description": "<string>",
      "colorHex": "<string>"
    }
  ],
  "booleanTrueLabel": "<string>",
  "booleanFalseLabel": "<string>",
  "gradesShortCalls": true,
  "classificationOptions": [
    {
      "label": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "maxClassifications": 2,
  "toolDefinitionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "supportedContexts": [],
  "formula": "<string>",
  "sources": [
    {
      "sourceMetricDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "changeReason": "<string>",
  "slug": "<unknown>",
  "metricId": "<unknown>",
  "source": "<unknown>",
  "organizationId": "<unknown>",
  "projectId": "<unknown>",
  "outputType": "<unknown>",
  "scope": "<unknown>",
  "participantRole": "<unknown>",
  "calcType": "<unknown>",
  "supportsMultipleVariants": "<unknown>",
  "analysisPackageId": "<unknown>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/metric/definitions/{idOrSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'llmPrompt' => '<string>',
    'scaleMin' => 50,
    'scaleMax' => 50,
    'scaleLabels' => [
        [
                'rangeMin' => 123,
                'rangeMax' => 123,
                'label' => '<string>',
                'displayOrder' => 123,
                'description' => '<string>',
                'colorHex' => '<string>'
        ]
    ],
    'booleanTrueLabel' => '<string>',
    'booleanFalseLabel' => '<string>',
    'gradesShortCalls' => true,
    'classificationOptions' => [
        [
                'label' => '<string>',
                'description' => '<string>',
                'displayOrder' => 123
        ]
    ],
    'maxClassifications' => 2,
    'toolDefinitionIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'supportedContexts' => [
        
    ],
    'formula' => '<string>',
    'sources' => [
        [
                'sourceMetricDefinitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'sourceVariantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ],
    'changeReason' => '<string>',
    'slug' => '<unknown>',
    'metricId' => '<unknown>',
    'source' => '<unknown>',
    'organizationId' => '<unknown>',
    'projectId' => '<unknown>',
    'outputType' => '<unknown>',
    'scope' => '<unknown>',
    'participantRole' => '<unknown>',
    'calcType' => '<unknown>',
    'supportsMultipleVariants' => '<unknown>',
    'analysisPackageId' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/metric/definitions/{idOrSlug}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.roark.ai/v1/metric/definitions/{idOrSlug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/metric/definitions/{idOrSlug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"llmPrompt\": \"<string>\",\n  \"scaleMin\": 50,\n  \"scaleMax\": 50,\n  \"scaleLabels\": [\n    {\n      \"rangeMin\": 123,\n      \"rangeMax\": 123,\n      \"label\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\",\n      \"colorHex\": \"<string>\"\n    }\n  ],\n  \"booleanTrueLabel\": \"<string>\",\n  \"booleanFalseLabel\": \"<string>\",\n  \"gradesShortCalls\": true,\n  \"classificationOptions\": [\n    {\n      \"label\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayOrder\": 123\n    }\n  ],\n  \"maxClassifications\": 2,\n  \"toolDefinitionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"supportedContexts\": [],\n  \"formula\": \"<string>\",\n  \"sources\": [\n    {\n      \"sourceMetricDefinitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"sourceVariantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"changeReason\": \"<string>\",\n  \"slug\": \"<unknown>\",\n  \"metricId\": \"<unknown>\",\n  \"source\": \"<unknown>\",\n  \"organizationId\": \"<unknown>\",\n  \"projectId\": \"<unknown>\",\n  \"outputType\": \"<unknown>\",\n  \"scope\": \"<unknown>\",\n  \"participantRole\": \"<unknown>\",\n  \"calcType\": \"<unknown>\",\n  \"supportsMultipleVariants\": \"<unknown>\",\n  \"analysisPackageId\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "metricId": "<string>",
    "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "type": "COUNT",
    "scope": "GLOBAL",
    "supportedContexts": [
      "CALL"
    ],
    "supportedConversationSources": [
      "SIMULATED"
    ],
    "gradesShortCalls": true,
    "requiresLiveConversation": true,
    "supportsVariants": true,
    "evidenceSource": {
      "metricId": "<string>",
      "countsWhen": true
    },
    "calculationType": "LLM_JUDGE",
    "llmPrompt": "<string>",
    "booleanTrueLabel": "<string>",
    "booleanFalseLabel": "<string>",
    "unit": {
      "name": "<string>",
      "symbol": "<string>"
    }
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idOrSlug

string

required

The metric definition's Roark ID (UUID) or its stable slug (e.g. customer_satisfaction).

Body

application/json

Editable subset of a metric definition. Every update creates a new immutable version. Immutable fields (slug, scope, outputType, calcType, …) are rejected with a 400.

name

string

New name (only for metrics whose name is editable)

Required string length: 1 - 100

llmPrompt

string

New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable). A custom metric prompt must include a transcript variable such as {{transcript}} and {{world_context}}, which gives the judge the current date and time when it grades.

Maximum string length: 20000

scaleMin

integer

New scale minimum (SCALE output only)

Required range: 0 <= x <= 100

scaleMax

integer

New scale maximum (SCALE output only)

Required range: 0 <= x <= 100

scaleLabels

object[]

Replacement set of scale-range labels (SCALE output only)

Show child attributes

booleanTrueLabel

string

New label for the true case (BOOLEAN output only)

booleanFalseLabel

string

New label for the false case (BOOLEAN output only)

gradesShortCalls

boolean

Score this metric on a simulated call with fewer than 4 transcript lines or where your agent never spoke (custom metrics only, not ones that judge the audio). Such calls skip every other metric. Default false.

classificationOptions

object[]

Replacement set of classification options (CLASSIFICATION output only)

Minimum array length: 1

Show child attributes

maxClassifications

integer

New maximum number of classifications (CLASSIFICATION output only)

Required range: x >= 1

toolDefinitionIds

string<uuid>[]

Replacement set of scoped tool-definition ids (only for metrics whose tool scoping is editable)

supportedContexts

enum<string>[]

Replacement set of supported contexts. Omit to leave unchanged. Scope and participantRole cannot change after create, so moving to SEGMENT or TURN grading only works on a PER_PARTICIPANT metric (see create).

Minimum array length: 1

Available options:

CALL,

SEGMENT,

TURN

formula

string

New formula expression (FORMULA only). Pass sources alongside if the referenced metrics change.

Required string length: 1 - 500

sources

object[]

Replacement formula sources, required when formula changes the referenced metrics (FORMULA only).

Show child attributes

httpRequest

HTTP request metric request · object

Replacement request (HTTP_REQUEST only). Send the whole request; omitted headers are removed.

Show child attributes

changeReason

string

Optional free-text audit note recorded on the new version.

slug

any

metricId

any

source

any

organizationId

any

projectId

any

outputType

any

scope

any

participantRole

any

calcType

any

supportsMultipleVariants

any

analysisPackageId

any

Response

The updated metric definition (with versionId advanced to the new version)

data

LLM judge metric · object

required

The updated metric definition. The variant is selected by calculationType.

LLM judge metric
Formula metric
Pattern metric
Threshold metric
HTTP request metric

Show child attributes