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

# Get metric health stats

> Compact machine-vs-human and human-vs-human agreement health for one metric, computed from its review annotations. Metric-scoped (no project).



## OpenAPI

````yaml /api-reference/v1/reviews-v1.yaml get /review-annotations/metric-health-stats
openapi: 3.0.3
info:
  title: Coval Reviews API
  version: 1.0.0
  description: >
    Manage human review annotations and projects for AI evaluation quality
    assurance.


    **Annotations** are individual review tasks assigned to reviewers, linked to
    a

    simulation output and metric. Reviewers provide ground-truth values and
    notes.


    **Projects** group annotations by linking sets of simulations, metrics, and

    assignees. Creating a project auto-generates annotations for every

    (simulation, metric, assignee) combination.


    Key concepts:

    - Ground truth updates auto-complete annotations (FR-4)

    - Resource naming: `review-annotations/{id}`, `review-projects/{id}`
  contact:
    name: Coval API Support
    email: support@coval.dev
    url: https://docs.coval.ai
  license:
    name: Proprietary
    url: https://coval.dev/terms
servers:
  - url: https://api.coval.dev/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Review Annotations
    description: Annotation CRUD operations
  - name: Review Projects
    description: Project CRUD operations
paths:
  /review-annotations/metric-health-stats:
    get:
      tags:
        - Review Annotations
      summary: Get metric health stats
      description: >-
        Compact machine-vs-human and human-vs-human agreement health for one
        metric, computed from its review annotations. Metric-scoped (no
        project).
      operationId: getReviewMetricHealthStats
      parameters:
        - name: metric_id
          in: query
          required: true
          schema:
            type: string
          description: The metric ID (22-char ShortUUID).
      responses:
        '200':
          description: Health stats computed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetricHealthStatsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetMetricHealthStatsResponse:
      type: object
      required:
        - conversations
        - annotations
        - agreement_rate
        - agreements
        - disagreements
        - human_agreement
      properties:
        conversations:
          type: integer
        annotations:
          type: integer
        agreement_rate:
          type: number
        agreements:
          type: integer
        disagreements:
          type: integer
        human_agreement:
          $ref: '#/components/schemas/HumanAgreementStatsResource'
    HumanAgreementStatsResource:
      type: object
      required:
        - human_agreement_rate
        - human_agreement_total
        - human_agreements
        - human_disagreements
      properties:
        human_agreement_rate:
          type: number
        human_agreement_total:
          type: integer
        human_agreements:
          type: integer
        human_disagreements:
          type: integer
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
              example: INVALID_ARGUMENT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameter
            details:
              type: array
              description: Detailed error information
              items:
                type: object
                properties:
                  field:
                    type: string
                    nullable: true
                    description: Field that caused the error
                  description:
                    type: string
                    description: Detailed error description
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INVALID_ARGUMENT
              message: Invalid request body
              details:
                - field: simulation_output_id
                  description: simulation_output_id is required
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: UNAUTHENTICATED
              message: Authentication failed
              details:
                - field: X-API-Key
                  description: Invalid or missing API key
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: PERMISSION_DENIED
              message: Insufficient permissions
              details:
                - field: permissions
                  description: >-
                    The API key does not include the required reviews
                    permission.
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INTERNAL
              message: Internal server error
              details:
                - description: An unexpected error occurred
    ServiceUnavailable:
      description: Service temporarily unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: INTERNAL
              message: Service temporarily unavailable
              details:
                - description: Database routing is temporarily unavailable. Please retry.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Organization API key for authentication

````