Skip to main content
GET
/
workflows
/
v1
/
simulations
/
{simulation_id}
/
evaluation-summary
Get Simulation Evaluation Summary Endpoint
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/simulations/{simulation_id}/evaluation-summary \
  --header 'Authorization: Bearer <token>'
{
  "simulation_id": "<string>",
  "group_id": "<string>",
  "selected_workflow_summary": {
    "total_runs": 0,
    "successful_evaluations": 0,
    "failed_evaluations": 0,
    "pending_evaluations": 0,
    "no_evaluation_configured": 0,
    "metrics": [
      {
        "metric_name": "<string>",
        "average_score": 123,
        "min_score": 123,
        "max_score": 123,
        "distribution": {
          "scale_upper_bound": 5,
          "bucket_0_20": 0,
          "bucket_21_40": 0,
          "bucket_41_60": 0,
          "bucket_61_80": 0,
          "bucket_81_100": 0
        }
      }
    ]
  },
  "counter_workflow_summary": {
    "total_runs": 0,
    "successful_evaluations": 0,
    "failed_evaluations": 0,
    "pending_evaluations": 0,
    "no_evaluation_configured": 0,
    "metrics": [
      {
        "metric_name": "<string>",
        "average_score": 123,
        "min_score": 123,
        "max_score": 123,
        "distribution": {
          "scale_upper_bound": 5,
          "bucket_0_20": 0,
          "bucket_21_40": 0,
          "bucket_41_60": 0,
          "bucket_61_80": 0,
          "bucket_81_100": 0
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

​
simulation_id
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

​
group_id
string
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Response

Successful Response

Response model for aggregated evaluation results across all runs of a simulation.

​
simulation_id
string
required

ID of the simulation configuration

​
group_id
string | null

ID of the specific simulation group (if filtering by group)

​
selected_workflow_summary
WorkflowEvaluationSummary · object

Evaluation summary for the selected (source) workflow. None if no evaluation configured.

​
counter_workflow_summary
WorkflowEvaluationSummary · object

Evaluation summary for the counter workflow. None if no evaluation configured.