> ## 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 Experiment Analytics Batch

> Return selected analytics slices in one request while preserving per-slice caches.



## OpenAPI

````yaml /openapi.json post /v1/experiments/{experiment_id}/analytics/batch
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}/analytics/batch:
    post:
      tags:
        - Analytics
      summary: Get Experiment Analytics Batch
      description: >-
        Return selected analytics slices in one request while preserving
        per-slice caches.
      operationId: >-
        get_experiment_analytics_batch_v1_experiments__experiment_id__analytics_batch_post
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyticsBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsBatchResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    AnalyticsBatchRequest:
      properties:
        rankings:
          $ref: '#/components/schemas/AnalyticsBatchRankingsRequest'
        sections:
          items:
            enum:
              - rankings
              - confidence
              - statistics
              - insights
              - parameter_analysis
              - candidate_benchmark
              - decision_overview
            type: string
          maxItems: 7
          minItems: 1
          title: Sections
          type: array
      required:
        - sections
      title: AnalyticsBatchRequest
      type: object
    AnalyticsBatchResponse:
      properties:
        candidate_benchmark:
          anyOf:
            - $ref: '#/components/schemas/CandidateBenchmarkResponse'
            - type: 'null'
        confidence:
          anyOf:
            - $ref: '#/components/schemas/ConfidenceResponse'
            - type: 'null'
        decision_overview:
          anyOf:
            - $ref: '#/components/schemas/DecisionOverviewResponse'
            - type: 'null'
        errors:
          additionalProperties:
            $ref: '#/components/schemas/AnalyticsBatchSectionError'
          title: Errors
          type: object
        insights:
          anyOf:
            - items:
                $ref: '#/components/schemas/InsightResponse'
              type: array
            - type: 'null'
          title: Insights
        parameter_analysis:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Parameter Analysis
        rankings:
          anyOf:
            - $ref: '#/components/schemas/RankingsListResponse'
            - type: 'null'
        statistics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Statistics
      title: AnalyticsBatchResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    AnalyticsBatchRankingsRequest:
      properties:
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Value
        axis_key:
          anyOf:
            - maxLength: 64
              minLength: 1
              type: string
            - type: 'null'
          title: Axis Key
        limit:
          default: 50
          maximum: 200
          minimum: 1
          title: Limit
          type: integer
      title: AnalyticsBatchRankingsRequest
      type: object
    CandidateBenchmarkResponse:
      description: Benchmark-only candidate-level aggregate analytics.
      properties:
        aggregation_policy:
          title: Aggregation Policy
          type: string
        analysis_available:
          title: Analysis Available
          type: boolean
        candidates:
          items:
            $ref: '#/components/schemas/CandidateBenchmarkRowResponse'
          title: Candidates
          type: array
        computed_at:
          format: date-time
          title: Computed At
          type: string
        issues:
          items:
            $ref: '#/components/schemas/CandidateBenchmarkIssueResponse'
          title: Issues
          type: array
        pairwise_matrix:
          items:
            $ref: '#/components/schemas/CandidateBenchmarkPairwiseMatrixRowResponse'
          title: Pairwise Matrix
          type: array
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        summary:
          anyOf:
            - $ref: '#/components/schemas/CandidateBenchmarkSummaryResponse'
            - type: 'null'
      required:
        - analysis_available
        - computed_at
        - aggregation_policy
      title: CandidateBenchmarkResponse
      type: object
    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
    DecisionOverviewResponse:
      description: Canonical decision-first standard results response.
      properties:
        collection:
          $ref: '#/components/schemas/DecisionOverviewCollectionResponse'
        collection_sufficient:
          title: Collection Sufficient
          type: boolean
        confidence:
          maximum: 100
          minimum: 0
          title: Confidence
          type: number
        evidence:
          $ref: '#/components/schemas/DecisionOverviewEvidenceResponse'
        experiment_id:
          format: uuid
          title: Experiment Id
          type: string
        leader:
          $ref: '#/components/schemas/DecisionOverviewLeaderResponse'
        next_actions:
          items:
            $ref: '#/components/schemas/DecisionOverviewActionResponse'
          title: Next Actions
          type: array
        parameter_insights:
          items:
            type: string
          title: Parameter Insights
          type: array
        variants:
          items:
            $ref: '#/components/schemas/DecisionOverviewVariantResponse'
          title: Variants
          type: array
        why:
          items:
            type: string
          title: Why
          type: array
      required:
        - experiment_id
        - confidence
        - collection_sufficient
        - leader
        - evidence
        - collection
      title: DecisionOverviewResponse
      type: object
    AnalyticsBatchSectionError:
      properties:
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
        message:
          title: Message
          type: string
      required:
        - message
      title: AnalyticsBatchSectionError
      type: object
    InsightResponse:
      description: A generated insight.
      properties:
        computed_at:
          format: date-time
          title: Computed At
          type: string
        confidence:
          title: Confidence
          type: number
        data:
          additionalProperties: true
          title: Data
          type: object
        id:
          format: uuid
          title: Id
          type: string
        insight_type:
          title: Insight Type
          type: string
        parameters:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Parameters
        text:
          title: Text
          type: string
      required:
        - id
        - insight_type
        - parameters
        - text
        - data
        - confidence
        - computed_at
      title: InsightResponse
      type: object
    RankingsListResponse:
      description: List of rankings for an experiment.
      properties:
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          description: If filtered by anchor, the anchor value
          title: Anchor Value
        axis_key:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Explicit criterion used for this ranking; null means
            combined/default behavior
          title: Axis Key
        computed_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Computed At
        ordering_policy:
          default: elo_fallback
          description: Ranking metric used for the returned row order
          title: Ordering Policy
          type: string
        rankings:
          items:
            $ref: '#/components/schemas/RankingResponse'
          title: Rankings
          type: array
        total:
          title: Total
          type: integer
      required:
        - rankings
        - total
      title: RankingsListResponse
      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
    CandidateBenchmarkRowResponse:
      description: Aggregate benchmark metrics for one candidate.
      properties:
        aggregate_rank:
          title: Aggregate Rank
          type: integer
        aggregate_score:
          title: Aggregate Score
          type: number
        anchor_win_rate:
          title: Anchor Win Rate
          type: number
        candidate_id:
          format: uuid
          title: Candidate Id
          type: string
        candidate_key:
          title: Candidate Key
          type: string
        candidate_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate Label
        eligible_anchor_count:
          title: Eligible Anchor Count
          type: integer
        runner_up_count:
          title: Runner Up Count
          type: integer
        top_finish_count:
          title: Top Finish Count
          type: integer
      required:
        - candidate_id
        - candidate_key
        - aggregate_score
        - aggregate_rank
        - eligible_anchor_count
        - anchor_win_rate
        - top_finish_count
        - runner_up_count
      title: CandidateBenchmarkRowResponse
      type: object
    CandidateBenchmarkIssueResponse:
      description: Aggregation issue that excluded an anchor/candidate cell.
      properties:
        anchor_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Anchor Id
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Value
        candidate_id:
          format: uuid
          title: Candidate Id
          type: string
        candidate_key:
          title: Candidate Key
          type: string
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
      required:
        - candidate_id
        - candidate_key
        - code
        - message
      title: CandidateBenchmarkIssueResponse
      type: object
    CandidateBenchmarkPairwiseMatrixRowResponse:
      description: Anchor-balanced head-to-head summary between two candidates.
      properties:
        anchor_wins_a:
          title: Anchor Wins A
          type: number
        anchor_wins_b:
          title: Anchor Wins B
          type: number
        candidate_a_id:
          format: uuid
          title: Candidate A Id
          type: string
        candidate_a_key:
          title: Candidate A Key
          type: string
        candidate_a_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate A Label
        candidate_b_id:
          format: uuid
          title: Candidate B Id
          type: string
        candidate_b_key:
          title: Candidate B Key
          type: string
        candidate_b_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Candidate B Label
        comparable_anchor_count:
          title: Comparable Anchor Count
          type: integer
        ties:
          title: Ties
          type: number
      required:
        - candidate_a_id
        - candidate_a_key
        - candidate_b_id
        - candidate_b_key
        - comparable_anchor_count
        - anchor_wins_a
        - anchor_wins_b
        - ties
      title: CandidateBenchmarkPairwiseMatrixRowResponse
      type: object
    CandidateBenchmarkSummaryResponse:
      description: Top-level decision summary for benchmark candidate aggregation.
      properties:
        ambiguous_cell_count:
          title: Ambiguous Cell Count
          type: integer
        confidence_inputs:
          $ref: '#/components/schemas/CandidateBenchmarkConfidenceInputsResponse'
        decision_status:
          title: Decision Status
          type: string
        eligible_anchor_count:
          title: Eligible Anchor Count
          type: integer
        total_anchor_count:
          title: Total Anchor Count
          type: integer
        winner_candidate_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Winner Candidate Id
        winner_candidate_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Winner Candidate Key
        winner_candidate_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Winner Candidate Label
      required:
        - decision_status
        - eligible_anchor_count
        - total_anchor_count
        - ambiguous_cell_count
        - confidence_inputs
      title: CandidateBenchmarkSummaryResponse
      type: object
    DecisionOverviewCollectionResponse:
      description: Collection, readiness, and budget state for standard results.
      properties:
        budget_message:
          title: Budget Message
          type: string
        budget_status:
          title: Budget Status
          type: string
        is_active:
          title: Is Active
          type: boolean
        readiness_state:
          anyOf:
            - type: string
            - type: 'null'
          title: Readiness State
        status:
          title: Status
          type: string
        votes_needed:
          anyOf:
            - type: integer
            - type: 'null'
          title: Votes Needed
      required:
        - status
        - is_active
        - budget_status
        - budget_message
      title: DecisionOverviewCollectionResponse
      type: object
    DecisionOverviewEvidenceResponse:
      description: Standard user evidence summary.
      properties:
        insufficient_data_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Insufficient Data Reason
        label:
          title: Label
          type: string
        output_count:
          title: Output Count
          type: integer
        prompt_count:
          title: Prompt Count
          type: integer
        score:
          maximum: 100
          minimum: 0
          title: Score
          type: number
        vote_count:
          title: Vote Count
          type: integer
      required:
        - label
        - score
        - vote_count
        - output_count
        - prompt_count
      title: DecisionOverviewEvidenceResponse
      type: object
    DecisionOverviewLeaderResponse:
      description: Standard results leader summary.
      properties:
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        reason:
          title: Reason
          type: string
        sample_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Sample Id
        status:
          title: Status
          type: string
      required:
        - status
        - reason
      title: DecisionOverviewLeaderResponse
      type: object
    DecisionOverviewActionResponse:
      description: Recommended next action for standard results.
      properties:
        action_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Action Label
        detail:
          title: Detail
          type: string
        href:
          anyOf:
            - type: string
            - type: 'null'
          title: Href
        title:
          title: Title
          type: string
      required:
        - title
        - detail
      title: DecisionOverviewActionResponse
      type: object
    DecisionOverviewVariantResponse:
      description: Compact supporting row for standard results.
      properties:
        id:
          format: uuid
          title: Id
          type: string
        label:
          title: Label
          type: string
        prompt_win_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Prompt Win Rate
        rank:
          title: Rank
          type: integer
        win_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Win Rate
      required:
        - id
        - label
        - rank
      title: DecisionOverviewVariantResponse
      type: object
    RankingResponse:
      description: Ranking data for a single sample.
      properties:
        anchor_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Anchor Value
        bt_ci_lower:
          anyOf:
            - type: number
            - type: 'null'
          title: Bt Ci Lower
        bt_ci_upper:
          anyOf:
            - type: number
            - type: 'null'
          title: Bt Ci Upper
        bt_rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Bt Rank
        bt_strength:
          anyOf:
            - type: number
            - type: 'null'
          title: Bt Strength
        comparisons:
          title: Comparisons
          type: integer
        elo_rank:
          title: Elo Rank
          type: integer
        elo_rating:
          title: Elo Rating
          type: number
        losses:
          title: Losses
          type: integer
        parameters:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Parameters
        sample_id:
          format: uuid
          title: Sample Id
          type: string
        win_rate:
          title: Win Rate
          type: number
        wins:
          title: Wins
          type: integer
      required:
        - sample_id
        - anchor_value
        - parameters
        - elo_rating
        - elo_rank
        - wins
        - losses
        - comparisons
        - win_rate
      title: RankingResponse
      type: object
    CandidateBenchmarkConfidenceInputsResponse:
      description: Inputs used to decide whether a candidate winner can be declared.
      properties:
        experiment_confidence:
          title: Experiment Confidence
          type: number
        runner_up_head_to_head_anchor_win_rate:
          title: Runner Up Head To Head Anchor Win Rate
          type: number
        top_margin:
          title: Top Margin
          type: number
      required:
        - experiment_confidence
        - top_margin
        - runner_up_head_to_head_anchor_win_rate
      title: CandidateBenchmarkConfidenceInputsResponse
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: Supabase JWT
      scheme: bearer
      type: http
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey

````