> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interactly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Simulation Evaluation Summary Endpoint

> Get aggregated evaluation results for a simulation across all runs.

Returns summary statistics for both selected and counter workflow evaluations including:
- Total runs, successful/failed/pending evaluation counts
- Average scores for each numeric metric
- Score distribution across ranges (0-20, 21-40, 41-60, 61-80, 81-100)

Optional: Filter by specific group_id to get summary for one batch run.



## OpenAPI

````yaml https://api-prod.interactly.ai/api-docs/workflows/api.json get /workflows/v1/simulations/{simulation_id}/evaluation-summary
openapi: 3.1.0
info:
  title: Interactly API
  description: API for building interactly.ai services
  version: 1.1.0
  contact:
    name: Interactly
    url: https://interactly.ai
    email: developers@interactly.ai
servers:
  - url: https://api-prod.interactly.ai
    description: API Server
security: []
paths:
  /workflows/v1/simulations/{simulation_id}/evaluation-summary:
    get:
      tags:
        - Simulations
      summary: Get Simulation Evaluation Summary Endpoint
      description: >-
        Get aggregated evaluation results for a simulation across all runs.


        Returns summary statistics for both selected and counter workflow
        evaluations including:

        - Total runs, successful/failed/pending evaluation counts

        - Average scores for each numeric metric

        - Score distribution across ranges (0-20, 21-40, 41-60, 61-80, 81-100)


        Optional: Filter by specific group_id to get summary for one batch run.
      operationId: >-
        workflow_service_get_simulation_evaluation_summary_endpoint_v1_simulations__simulation_id__evaluation_summary_get
      parameters:
        - name: simulation_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/PydanticObjectId'
        - name: group_id
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PydanticObjectId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationEvaluationSummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - bearer: []
components:
  schemas:
    PydanticObjectId:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[0-9a-f]{24}$
      example: 5eb7cf5a86d9755df3a6c593
    SimulationEvaluationSummaryResponse:
      properties:
        simulation_id:
          type: string
          title: Simulation Id
          description: ID of the simulation configuration
        group_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Id
          description: ID of the specific simulation group (if filtering by group)
        selected_workflow_summary:
          anyOf:
            - $ref: '#/components/schemas/WorkflowEvaluationSummary'
            - type: 'null'
          description: >-
            Evaluation summary for the selected (source) workflow. None if no
            evaluation configured.
        counter_workflow_summary:
          anyOf:
            - $ref: '#/components/schemas/WorkflowEvaluationSummary'
            - type: 'null'
          description: >-
            Evaluation summary for the counter workflow. None if no evaluation
            configured.
      type: object
      required:
        - simulation_id
      title: SimulationEvaluationSummaryResponse
      description: >-
        Response model for aggregated evaluation results across all runs of a
        simulation.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkflowEvaluationSummary:
      properties:
        total_runs:
          type: integer
          title: Total Runs
          description: Total number of individual simulation runs
          default: 0
        successful_evaluations:
          type: integer
          title: Successful Evaluations
          description: Number of runs where evaluation completed successfully
          default: 0
        failed_evaluations:
          type: integer
          title: Failed Evaluations
          description: Number of runs where evaluation failed
          default: 0
        pending_evaluations:
          type: integer
          title: Pending Evaluations
          description: Number of runs where evaluation is still pending
          default: 0
        no_evaluation_configured:
          type: integer
          title: No Evaluation Configured
          description: Number of runs with no evaluation workflow configured
          default: 0
        metrics:
          items:
            $ref: '#/components/schemas/EvaluationMetricSummary'
          type: array
          title: Metrics
          description: Summary statistics for each numeric evaluation metric
      type: object
      title: WorkflowEvaluationSummary
      description: >-
        Aggregated evaluation summary for a workflow (selected or counter)
        across all simulation runs.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    EvaluationMetricSummary:
      properties:
        metric_name:
          type: string
          title: Metric Name
          description: Name of the evaluation metric
        average_score:
          type: number
          title: Average Score
          description: Average score across all successful runs
        min_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Min Score
          description: Minimum score observed
        max_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Max Score
          description: Maximum score observed
        distribution:
          $ref: '#/components/schemas/ScoreDistribution'
          description: Distribution of scores across ranges
      type: object
      required:
        - metric_name
        - average_score
      title: EvaluationMetricSummary
      description: Summary statistics for a single evaluation metric across all runs.
    ScoreDistribution:
      properties:
        scale_upper_bound:
          type: number
          title: Scale Upper Bound
          description: Upper bound of the score scale used for bucketing
          default: 5
        bucket_0_20:
          type: integer
          title: Bucket 0 20
          description: Count of scores in range 0-20% of scale
          default: 0
        bucket_21_40:
          type: integer
          title: Bucket 21 40
          description: Count of scores in range 20-40% of scale
          default: 0
        bucket_41_60:
          type: integer
          title: Bucket 41 60
          description: Count of scores in range 40-60% of scale
          default: 0
        bucket_61_80:
          type: integer
          title: Bucket 61 80
          description: Count of scores in range 60-80% of scale
          default: 0
        bucket_81_100:
          type: integer
          title: Bucket 81 100
          description: Count of scores in range 80-100% of scale
          default: 0
      type: object
      title: ScoreDistribution
      description: |-
        Distribution of scores across different ranges.
        Default scale is 0-5, auto-scales to max score if any value exceeds 5.
        Buckets represent 20% intervals of the scale_upper_bound.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: Bearer
      type: http
      description: >-
        Retrieve your API Key from [Dashboard API Keys
        Section](https://dashboard.interactly.ai/api-keys).

````