> ## 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 Confidence

> Get confidence metrics for an experiment.



## OpenAPI

````yaml /openapi.json get /v1/experiments/{experiment_id}/confidence
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}/confidence:
    get:
      tags:
        - Analytics
      summary: Get Confidence
      description: Get confidence metrics for an experiment.
      operationId: get_confidence_v1_experiments__experiment_id__confidence_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/ConfidenceResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    ConfidenceResponse:
      description: >-
        Confidence metrics for an experiment.


        ``overall_confidence`` is the headline DECISION confidence (how sure we
        are

        the recommended configuration beats a typical one). ``signal_strength``
        is

        the PPC predictability sub-metric (null-safe honesty guard). The
        per-claim

        ``parameter_report`` + ``recommended_config`` carry the "big picture".
      properties:
        axes:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Axis metadata (axis_key/label/description/weight)
          title: Axes
        combined:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Weighted combined recommended config across axes
          title: Combined
        components:
          additionalProperties:
            type: number
          description: Sub-metric breakdown (decision/signal/skill/depth/breadth)
          title: Components
          type: object
        computed_at:
          format: date-time
          title: Computed At
          type: string
        decision_ci:
          anyOf:
            - items:
                type: number
              type: array
            - type: 'null'
          description: 90% CI for decision confidence
          title: Decision Ci
        is_multi_axis:
          anyOf:
            - type: boolean
            - type: 'null'
          description: True iff the experiment defines explicit voting axes
          title: Is Multi Axis
        overall_confidence:
          description: Headline decision confidence (0-100)
          maximum: 100
          minimum: 0
          title: Overall Confidence
          type: number
        parameter_report:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          description: Per-parameter effects/curves with per-claim confidence chips
          title: Parameter Report
        recommended_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Synthesized recommended configuration
          title: Recommended Config
        report_by_axis:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Per-axis confidence report keyed by axis_key
          title: Report By Axis
        signal_strength:
          anyOf:
            - type: number
            - type: 'null'
          description: PPC predictive skill 0-100 (null-safe guard)
          title: Signal Strength
        total_samples:
          title: Total Samples
          type: integer
        total_votes:
          title: Total Votes
          type: integer
      required:
        - overall_confidence
        - components
        - total_votes
        - total_samples
        - computed_at
      title: ConfidenceResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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

````