​
Get Result API

Retrieve a result by ID

​
API Endpoint

MethodEndpoint
GEThttps://new-prod.vocera.ai/test_framework/v1/results-external/:result-id/

​
Authentication

Include your API key in the request headers:

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

​
URL Parameters

Include the result ID in the URL:

ParameterTypeRequiredDescription
result-idintegerYesID of the result

​
Response Format

A successful request returns details about created result.

​
Response Fields

FieldTypeDescription
idintegerThe result ID
namestringResult label
agentintegerID of associated agent
statusstringStatus of the result, can be one of:
• running - Initial state when evaluator starts
• in_progress - Call is currently executing
• completed - Call has finished successfully
• failed - Call encountered an error
• pending - Testing agent is waiting to be called
success_ratefloatPercentage of runs that passed
run_as_textbooleanIf executed as text (llm websocket) or not
runsobjectMap of run objects, keyed by run ID
created_atstringISO 8601 timestamp of when the result was created

​
Run Object Fields

FieldTypeDescription
idintegerThe run ID
scenarioobjectDetails about the test scenario
successbooleanWhether the run passed or failed
evaluationobjectEvaluation metrics and scores
transcript_objectarrayList of conversation turns with timestamps
voice_recordingstringURL to the voice recording file
timestampstringISO 8601 timestamp of the run

​
Example Response

{
    "id": 30,
    "name": "result-label",
    "agent": 1,
    "status": "completed",
    "success_rate": 100.0,
    "run_as_text": false,
    "runs": {
        "41": {
            "id": 41,
            "scenario": {
                "id": 44,
                "name": "\"Secure SIM Confusion Call Test\"",
                "personality_name": "Highly Interruptive American Man"
            },
            "success": true,
            "evaluation": {
                "metrics": [
                    {
                        "id": 2,
                        "name": "Call Pickup",
                        "type": "binary_workflow_adherence",
                        "score": 5,
                        "explanation": [
                            "The AI agent says 'Hello.'",
                            "The AI agent responded, indicating the call was picked up.",
                            "No arguments against meeting the metric",
                            "The AI agent meets the metric as the call was picked up"
                        ],
                        "vocera_defined_metric_code": "xyz"
                    }
                    // ... additional metrics omitted for brevity ...
                ]
            },
            "transcript_object": [
                {
                    "role": "Testing Agent",
                    "time": "0:01",
                    "content": "Hello.",
                    "end_time": 2.0399999,
                    "start_time": 1.5999999
                }
            ],
            "voice_recording": "https://example.com/recording.wav",
            "timestamp": "2024-12-02T15:38:45.474848Z"
        }
    },
    "created_at": "2024-12-02T15:38:45.435335Z"
}

​
Code Examples

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