​
Reevaluate Metrics API

Reevaluate specific metrics for selected test runs

​
API Endpoint

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

​
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 to reevaluate

​
Request Body

FieldTypeRequiredDescription
run_idsarrayYesArray of run IDs to reevaluate
metric_idsarrayYesArray of metric IDs to reevaluate

​
Example Request

{

    "run_ids": [16, 17],

    "metric_ids": [1, 2, 3]

}

​
Response Format

A successful request returns details about the reevaluation result.

​
Response Fields

FieldTypeDescription
idintegerThe result ID
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

​
Example Response

{

    "id": 7,

    "agent": 1,

    "status": "completed",

    "success_rate": 0,

    "run_as_text": false

}

​
Code Examples

curl -X POST https://new-prod.vocera.ai/test_framework/v1/results-external/:your-result-id/evaluate_metrics/ \

  -H "X-VOCERA-API-KEY: <your-api-key-here>" \

  -H "Content-Type: application/json" \

  -d '{

    "run_ids": [16, 17],

    "metric_ids": [1, 2, 3]

  }'