​
Get Evaluator API

Retrieve details for a specific evaluator by its ID.

​
API Endpoint

MethodEndpoint
GEThttps://new-prod.vocera.ai/test_framework/v1/scenarios-external/:scenario-id/

​
Authentication

Include your API key in the request headers:

HeaderDescription
X-VOCERA-API-KEYYour API key obtained from the dashboard

​
URL Parameters

ParameterTypeRequiredDescription
scenario-idintegerYesID of the evaluator to retrieve

​
Response Format

The API returns detailed information about the specified evaluator.

​
Response Fields

FieldTypeDescription
idintegerUnique identifier for the evaluator
namestringName of the evaluator
agentintegerID of the associated agent
personalityintegerID of the personality used
personality_namestringHuman-readable name of the personality
tagsarrayList of tags associated with the evaluator
runsarrayList of evaluator run IDs
metricsarrayList of metric IDs
metric_namesarrayList of human-readable metric names
first_messagestringInitial message for the conversation
inbound_phone_numberinteger|nullID of the inbound phone number
inbound_phone_number_dataobject|nullDetails about the inbound phone number (see below)
instructionsstringEvaluator instructions
expected_outcome_promptstringPrompt to evaluate expected outcome

​
Inbound Phone Number Data Fields

FieldTypeDescription
idintegerInternal ID of the phone number record
numberstringThe phone number in E.164 format
phone_number_idstringExternal reference ID for the phone number

​
Example Response

{
    "id": 15,
    "name": "Customer Service Evaluation - Angry Customer",
    "agent": 123,
    "personality": 456,
    "personality_name": "Frustrated Customer Persona",
    "tags": ["angry_customer", "product_complaint", "high_priority"],
    "runs": [501, 502, 503],
    "metrics": [789, 790, 791],
    "metric_names": [
        "Customer Satisfaction Score",
        "Resolution Time",
        "Agent Empathy Rating"
    ],
    "first_message": "I need to speak with someone about this broken laptop I received!",
    "inbound_phone_number": 2,
    "inbound_phone_number_data": {
        "id": 2,
        "number": "+1234567890",
        "phone_number_id": "123"
    },
    "instructions": "Act as an angry customer who received a defective product. Be persistent but not abusive.",
    "expected_outcome_prompt": "Issue was resolved with a refund or replacement"
}

​
Code Examples

curl -X GET https://new-prod.vocera.ai/test_framework/v1/scenarios-external/:scenario-id/ \
  -H "X-VOCERA-API-KEY: <your-api-key-here>"