Skip to main content
GET
/
v1
/
evaluation
/
evaluators
/
{evaluatorId}
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.evaluation.getEvaluatorById('evaluatorId');

console.log(response.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "blocks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "weight": 50,
      "orderIndex": 123,
      "blockType": "<string>",
      "prompt": "<string>",
      "threshold": 0.5,
      "metricName": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
evaluatorId
string
required

The ID of the evaluator to retrieve

Response

The requested evaluator with its blocks

Evaluator with its configured blocks

​
id
string<uuid>
required

Unique identifier for the evaluator

​
name
string
required

Name of the evaluator

​
slug
string
required

Unique slug identifier for the evaluator

​
description
string | null
required

Optional description of the evaluator

​
createdAt
string
required

ISO timestamp when the evaluator was created

​
updatedAt
string
required

ISO timestamp when the evaluator was last updated

​
blocks
object[]
required

Array of evaluation blocks configured for this evaluator

Evaluation block with type-specific configuration flattened into the object