POST
/
test_framework
/
v1
/
results
/
{id}
/
evaluate_metrics
/
cURL
curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/results/{id}/evaluate_metrics/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '{
  "run_ids": [
    "<string>"
  ],
  "metric_ids": [
    "<string>"
  ]
}'
{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "status": "running",
  "success_rate": 0,
  "run_as_text": false,
  "is_cronjob": "<string>",
  "runs": "<string>",
  "met_expected_outcome_count": "<string>",
  "total_expected_outcome_count": "<string>",
  "total_runs_count": "<string>",
  "completed_runs_count": "<string>",
  "success_runs_count": "<string>",
  "failed_runs_count": "<string>",
  "scenarios": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Path Parameters

​
id
integer
required

A unique integer value identifying this result.

Body

​
run_ids
string[]
required

List of run IDs

Minimum length: 1
​
metric_ids
string[]
required

List of metric IDs to evaluate

Minimum length: 1

Response

200 - application/json

Mixin for parsing restql query from request.

NOTE: We are using request.GET instead of request.query_params because this might be called before DRF request is created(i.e from dispatch). This means request.query_params might not be available when this mixin is used.

​
id
integer
required

Unique identifier for this test result

​
name
string
required

Name or description of this test result

Maximum length: 255
​
agent
integer
required

ID of the AI agent that was tested

​
is_cronjob
string
required

Whether this result was created by a scheduled cronjob

​
runs
string
required

List of test runs associated with this result, including run details, status, scenario information, and phone numbers used

​
met_expected_outcome_count
string
required

Number of test runs that met the expected outcome criteria

​
total_expected_outcome_count
string
required

Total number of test runs that were evaluated for expected outcomes

​
total_runs_count
string
required

Total number of test runs associated with this result

​
completed_runs_count
string
required

Number of test runs that have completed successfully

​
success_runs_count
string
required

Number of test runs that were marked as successful

​
failed_runs_count
string
required

Number of test runs that failed or encountered errors

​
scenarios
string
required

List of scenario names used in the test runs for this result

​
created_at
string<date-time>
required

Timestamp when this test result was created

​
updated_at
string<date-time>
required

Timestamp when this test result was last updated

​
status
enum<string>
default:pending

Current status of the test result (e.g., running, completed, failed)

  • running - Running
  • completed - Completed
  • failed - Failed
  • pending - Pending
  • in_progress - In Progress
  • evaluating - Evaluating
  • in_queue - In Queue
  • timeout - Timeout
Available options:
running,
completed,
failed,
pending,
in_progress,
evaluating,
in_queue,
timeout
​
success_rate
number
default:0

Success rate of the test runs as a decimal (0.0 to 1.0)

​
run_as_text
boolean
default:false

Whether this test was run in text mode instead of voice mode