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

# Get Dashboard Summary

> Get the evaluation dashboard summary for cards and overview.



## OpenAPI

````yaml /openapi.json get /v1/experiments/{experiment_id}/dashboard
openapi: 3.1.0
info:
  description: Customer-owned evaluation lifecycle API.
  title: HeyBee Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.heybee.app
security: []
paths:
  /v1/experiments/{experiment_id}/dashboard:
    get:
      tags:
        - Analytics
      summary: Get Dashboard Summary
      description: Get the evaluation dashboard summary for cards and overview.
      operationId: get_dashboard_summary_v1_experiments__experiment_id__dashboard_get
      parameters:
        - in: path
          name: experiment_id
          required: true
          schema:
            format: uuid
            title: Experiment Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentDashboardResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    ExperimentDashboardResponse:
      description: Dashboard summary payload for experiment cards and overview.
      properties:
        activity:
          items:
            $ref: '#/components/schemas/DashboardActivityPointResponse'
          title: Activity
          type: array
        experiment_id:
          format: uuid
          title: Experiment Id
          type: string
        progress:
          $ref: '#/components/schemas/DashboardProgressResponse'
        results:
          anyOf:
            - $ref: '#/components/schemas/DashboardSimpleResultsResponse'
            - type: 'null'
        sample_breakdown:
          items:
            $ref: '#/components/schemas/DashboardSampleBreakdownResponse'
          title: Sample Breakdown
          type: array
        sample_summary:
          $ref: '#/components/schemas/DashboardSampleSummaryResponse'
      required:
        - experiment_id
        - progress
      title: ExperimentDashboardResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    DashboardActivityPointResponse:
      description: Daily vote activity point.
      properties:
        date:
          title: Date
          type: string
        feedback:
          title: Feedback
          type: integer
        votes:
          title: Votes
          type: integer
      required:
        - date
        - votes
        - feedback
      title: DashboardActivityPointResponse
      type: object
    DashboardProgressResponse:
      description: Current completion snapshot.
      properties:
        completed_votes:
          title: Completed Votes
          type: integer
        completion_ratio:
          title: Completion Ratio
          type: number
        target_votes:
          title: Target Votes
          type: integer
      required:
        - completed_votes
        - target_votes
        - completion_ratio
      title: DashboardProgressResponse
      type: object
    DashboardSimpleResultsResponse:
      description: Simple experiment dashboard result bundle.
      properties:
        chi_square:
          title: Chi Square
          type: number
        confidence_interval:
          maxItems: 2
          minItems: 2
          prefixItems:
            - type: number
            - type: number
          title: Confidence Interval
          type: array
        confidence_level:
          title: Confidence Level
          type: number
        experiment_id:
          format: uuid
          title: Experiment Id
          type: string
        is_significant:
          title: Is Significant
          type: boolean
        min_samples_needed:
          title: Min Samples Needed
          type: integer
        p_value:
          title: P Value
          type: number
        recommended_winner:
          title: Recommended Winner
          type: string
        sample_a_wins:
          title: Sample A Wins
          type: integer
        sample_b_wins:
          title: Sample B Wins
          type: integer
        total_votes:
          title: Total Votes
          type: integer
        win_rate_a:
          title: Win Rate A
          type: number
        win_rate_b:
          title: Win Rate B
          type: number
      required:
        - experiment_id
        - total_votes
        - sample_a_wins
        - sample_b_wins
        - win_rate_a
        - win_rate_b
        - chi_square
        - p_value
        - is_significant
        - confidence_level
        - confidence_interval
        - recommended_winner
        - min_samples_needed
      title: DashboardSimpleResultsResponse
      type: object
    DashboardSampleBreakdownResponse:
      description: Dashboard sample breakdown item.
      properties:
        model_name:
          title: Model Name
          type: string
        pair_position:
          default: A
          title: Pair Position
          type: string
        sample_id:
          format: uuid
          title: Sample Id
          type: string
        wins:
          title: Wins
          type: integer
      required:
        - sample_id
        - model_name
        - wins
      title: DashboardSampleBreakdownResponse
      type: object
    DashboardSampleSummaryResponse:
      description: Aggregate sample summary for workspace dashboards.
      properties:
        avg_elo:
          anyOf:
            - type: integer
            - type: 'null'
          title: Avg Elo
        max_elo:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Elo
        min_elo:
          anyOf:
            - type: integer
            - type: 'null'
          title: Min Elo
        total_comparisons:
          default: 0
          title: Total Comparisons
          type: integer
        total_samples:
          default: 0
          title: Total Samples
          type: integer
      title: DashboardSampleSummaryResponse
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: Supabase JWT
      scheme: bearer
      type: http
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````