​
Get Runs Bulk API

Retrieve multiple runs by their IDs in a single request

​
API Endpoint

MethodEndpoint
GEThttps://new-prod.vocera.ai/test_framework/v1/runs-external/bulk/

​
Authentication

Include your API key in the request headers:

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

​
Query Parameters

ParameterTypeRequiredDescription
run_idsstringYesComma-separated list of run IDs to retrieve

​
Response Format

The API returns an array of run objects.

​
Run Object Fields

FieldTypeDescription
idintegerThe run ID
scenariointegerID of the associated scenario
scenario_namestringName of the scenario
successbooleanWhether the run passed or failed
evaluationobject|nullEvaluation results and metrics
transcriptstringFull conversation transcript
transcript_objectarrayStructured conversation turns
durationstringTotal duration of the run
voice_recording_urlstring|nullURL to voice recording if available
email_idstring|nullAssociated email ID if applicable
statusstringStatus of the run, 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
metadataobject|nullAdditional metadata
timestampstringISO 8601 timestamp of the run
critical_categoriesarrayList of critical workflow metric categories and scenarios

​
Critical Category Object Fields

FieldTypeDescription
categorystringDescription of the critical issue identified
scenario_idintegerID of the scenario where the issue occurred
scenariostringDetailed explanation of how the issue manifested
prioritystringPriority level of the issue (e.g., “high”, “medium”, “low” and “not_a_bug”)

​
Example Response

[

    {

        "id": 181,

        "scenario": 67,

        "scenario_name": "Demo scenario",

        "success": true,

        "evaluation": {

            "metrics": [

                {

                    "id": 33,

                    "name": "Latency",

                    "type": "numeric",

                    "score": 3024.03,

                    "explanation": "",

                    "function_name": "get_latency"

                }

                // Additional metrics...

            ]

        },

        "transcript": "...",

        "transcript_object": [...],

        "duration": "01:02",

        "voice_recording_url": null,

        "status": "completed",

        "timestamp": "2025-01-08T12:06:15.042852Z",

        "critical_categories": [

            {

                "category": "Agent failed to verify customer identity before discussing account details",

                "scenario_id": 67,

                "scenario": "Agent proceeded with account discussion without completing required identity verification steps",

                "priority": "high"

            },

            {

                "category": "Agent provided incorrect information about service pricing",

                "scenario_id": 67,

                "scenario": "Agent quoted outdated pricing information instead of checking current rates",

                "priority": "medium"

            }

        ]

    }

    // Additional runs...

]

Transcript JSON Example:

[

   {

      "role": "Testing Agent",

      "time": "0:01",

      "content": "Hello.",

      "end_time": 1.9399999,

      "start_time": 1.4399999

   },

   {

      "role": "Main Agent",

      "time": "0:03",

      "content": "Hello. I want to book appointment today. My name is John.",

      "end_time": 7.539999511718751,

      "start_time": 3.1

   },

   {

      "role": "Testing Agent",

      "time": "0:12",

      "content": "Well, I mean, sure. What time exactly are we talking about here",

      "end_time": 15.71,

      "start_time": 12.01

   },

   {

      "role": "Main Agent",

      "time": "0:17",

      "content": "6 PM.",

      "end_time": 18.269999,

      "start_time": 17.609999

   },

   {

      "role": "Testing Agent",

      "time": "0:19",

      "content": "Great. I'll book that for you. Just a sec.",

      "end_time": 21.45,

      "start_time": 19.16

   },

   {

      "role": "Main Agent",

      "time": "0:22",

      "content": "Okay.",

      "end_time": 23.25,

      "start_time": 22.75

   },

   {

      "data": {

         "id": "call_5otWH44dxeXEHY8RlhYYaFbV",

         "name": "bookUserAppointment",

         "arguments": "{\"name\": \"John\", \"datetime\": \"2024-10-17T18:00:00\"}"

      },

      "role": "Function Call",

      "time": "0:23",

      "content": "",

      "end_time": 23.164,

      "start_time": 23.164

   },

   {

      "data": {

         "id": "call_5otWH44dxeXEHY8RlhYYaFbV",

         "name": "bookUserAppointment",

         "result": "No result returned."

      },

      "role": "Function Call Result",

      "time": "0:24",

      "end_time": 24.6,

      "start_time": 24.6

   },

   {

      "role": "Testing Agent",

      "time": "0:25",

      "content": "1 moment.",

      "end_time": 25.92,

      "start_time": 25.1

   },

   {

      "role": "Main Agent",

      "time": "0:27",

      "content": "Yes. Yes.",

      "end_time": 27.979999999999997,

      "start_time": 27.08

   },

   {

      "role": "Testing Agent",

      "time": "0:27",

      "content": "Appointment booked for 6 PM today.",

      "end_time": 29.5,

      "start_time": 27.08

   },

   {

      "role": "Main Agent",

      "time": "0:30",

      "content": "Oh, okay. Bye.",

      "end_time": 31.72,

      "start_time": 30.64

   },

   {

      "role": "Testing Agent",

      "time": "0:33",

      "content": "Bye.",

      "end_time": 33.6,

      "start_time": 33.1

   }

]

​
Code Examples

curl -X GET "https://new-prod.vocera.ai/test_framework/v1/runs-external/bulk/?run_ids=181,180" \

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