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

# Get automation review health

> Aggregates reviewed correctness, review coverage, bucketed counts, and rolling-window confidence for one automation. Prefer this endpoint for single-automation monitoring dashboards.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/automations/{id}/reviews/health
openapi: 3.1.0
info:
  title: Eigenpal API
  version: 1.0.0
  description: >-
    Public REST API for inspecting automations, starting and monitoring runs,
    managing files, collecting human reviews, and running evaluations.
  contact:
    name: Eigenpal
    url: https://eigenpal.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: https://api.eigenpal.com
    description: Production (canonical API hostname)
security:
  - bearerAuth: []
tags:
  - name: Metadata
    description: Authenticate and inspect the current API context.
  - name: Automations
    description: >-
      Inspect runnable workflow and agent automations, their versions, triggers,
      and source sync state.
  - name: Runs
    description: >-
      Start, monitor, retry, review, and debug automation runs, including
      artifacts.
  - name: Reviews
    description: >-
      Record human review verdicts, manage corrected outputs, and monitor review
      health.
  - name: Files
    description: Upload reusable files for later run or dataset use.
  - name: Evaluation
    description: >-
      Manage datasets, examples, evaluators, experiment batches, evaluator
      scores, and run promotion workflows.
paths:
  /v1/automations/{id}/reviews/health:
    get:
      tags:
        - Reviews
      summary: Get automation review health
      description: >-
        Aggregates reviewed correctness, review coverage, bucketed counts, and
        rolling-window confidence for one automation. Prefer this endpoint for
        single-automation monitoring dashboards.
      operationId: automations.reviews.health
      parameters:
        - in: path
          name: id
          schema:
            type: string
            description: >-
              Workflow id, agent id, or typed alias like workflows.slug /
              agents.slug.
          required: true
          description: >-
            Workflow id, agent id, or typed alias like workflows.slug /
            agents.slug.
        - in: query
          name: type
          schema:
            description: 'Comma-separated: workflow,agent.'
            type: string
          description: 'Comma-separated: workflow,agent.'
        - in: query
          name: status
          schema:
            description: Comma-separated execution statuses.
            type: string
          description: Comma-separated execution statuses.
        - in: query
          name: trigger
          schema:
            description: Comma-separated trigger types.
            type: string
          description: Comma-separated trigger types.
        - in: query
          name: triggeredBy
          schema:
            description: Comma-separated user ids, or __system__ for system-triggered runs.
            type: string
          description: Comma-separated user ids, or __system__ for system-triggered runs.
        - in: query
          name: sourceRef
          schema:
            type: string
        - in: query
          name: batchId
          schema:
            type: string
        - in: query
          name: exampleId
          schema:
            type: string
        - in: query
          name: exampleIdContains
          schema:
            type: string
        - in: query
          name: from
          schema:
            description: Start of the run-created time range. Defaults to now-30d.
            type: string
          description: Start of the run-created time range. Defaults to now-30d.
        - in: query
          name: to
          schema:
            description: End of the run-created time range.
            type: string
          description: End of the run-created time range.
        - in: query
          name: completedAfter
          schema:
            type: string
        - in: query
          name: completedBefore
          schema:
            type: string
        - in: query
          name: experiments
          schema:
            description: Set to false to exclude experiment batch runs.
            type: string
          description: Set to false to exclude experiment batch runs.
        - in: query
          name: bucket
          schema:
            description: Calendar bucket size for the bar chart series. Defaults to day.
            type: string
            enum:
              - day
              - week
              - month
          description: Calendar bucket size for the bar chart series. Defaults to day.
        - in: query
          name: rollingWindow
          schema:
            description: >-
              Number of reviewed runs per rolling correctness point. Defaults to
              100.
            type: integer
            minimum: 1
            maximum: 1000
          description: >-
            Number of reviewed runs per rolling correctness point. Defaults to
            100.
        - in: query
          name: minRollingReviews
          schema:
            description: >-
              Minimum reviewed runs required before emitting rolling points.
              Defaults to 1.
            type: integer
            minimum: 1
            maximum: 1000
          description: >-
            Minimum reviewed runs required before emitting rolling points.
            Defaults to 1.
      responses:
        '200':
          description: Automation review health metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunReviewHealthResponse'
        '400':
          description: Validation error. Request shape did not match the spec.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '403':
          description: API key lacks required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '413':
          description: Payload too large. Upload exceeded the per-request size cap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Seconds until the next request may succeed
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
components:
  schemas:
    RunReviewHealthResponse:
      type: object
      properties:
        timeRange:
          type: object
          properties:
            from:
              type: string
            to:
              type: string
          required:
            - from
            - to
          additionalProperties: false
        granularity:
          type: object
          properties:
            bucket:
              type: string
              enum:
                - day
                - week
                - month
            rollingWindow:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            minRollingReviews:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - bucket
            - rollingWindow
            - minRollingReviews
          additionalProperties: false
        summary:
          $ref: '#/components/schemas/RunReviewHealthSummary'
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/RunReviewHealthBucket'
        rolling:
          type: array
          items:
            $ref: '#/components/schemas/RunReviewHealthRollingPoint'
      required:
        - timeRange
        - granularity
        - summary
        - buckets
        - rolling
      additionalProperties: false
    ApiErrorEnvelope:
      type: object
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorIssue'
        requestId:
          type: string
          description: Request id echoed via the x-request-id header
        hint:
          description: Suggested fix for known error patterns
          type: string
        docsUrl:
          description: Link to relevant docs
          type: string
      required:
        - issues
        - requestId
      additionalProperties: false
    RunReviewHealthSummary:
      type: object
      properties:
        totalRuns:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        reviewedRuns:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Runs with a ranked verdict (`correct` or `incorrect`). Null verdict
            (nit) is excluded.
        reviewCoverage:
          anyOf:
            - type: number
            - type: 'null'
        correctReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        incorrectReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        nitReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Runs with a review row and null verdict (nit). Excluded from review
            coverage and accuracy.
        reviewedCorrectness:
          anyOf:
            - type: number
            - type: 'null'
        confidence:
          $ref: '#/components/schemas/RunReviewHealthConfidence'
      required:
        - totalRuns
        - reviewedRuns
        - reviewCoverage
        - correctReviews
        - incorrectReviews
        - nitReviews
        - reviewedCorrectness
        - confidence
      additionalProperties: false
    RunReviewHealthBucket:
      type: object
      properties:
        start:
          type: string
        end:
          type: string
        totalRuns:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        reviewedRuns:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Runs with a ranked verdict (`correct` or `incorrect`). Null verdict
            (nit) is excluded.
        reviewCoverage:
          anyOf:
            - type: number
            - type: 'null'
        correctReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        incorrectReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        nitReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Runs with a review row and null verdict (nit). Excluded from review
            coverage and accuracy.
        reviewedCorrectness:
          anyOf:
            - type: number
            - type: 'null'
      required:
        - start
        - end
        - totalRuns
        - reviewedRuns
        - reviewCoverage
        - correctReviews
        - incorrectReviews
        - nitReviews
        - reviewedCorrectness
      additionalProperties: false
    RunReviewHealthRollingPoint:
      type: object
      properties:
        at:
          type: string
        reviewedRuns:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: >-
            Runs with a ranked verdict (`correct` or `incorrect`). Null verdict
            (nit) is excluded.
        correctReviews:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        reviewedCorrectness:
          type: number
        confidenceLower:
          type: number
        confidenceUpper:
          type: number
        totalRunsInWindow:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Total production runs in the rolling window ending at this point.
        reviewCoverage:
          type: number
          description: >-
            Share of runs in the rolling window that were reviewed (0-1). Uses
            the same window size as rolling accuracy, applied to all runs.
      required:
        - at
        - reviewedRuns
        - correctReviews
        - reviewedCorrectness
        - confidenceLower
        - confidenceUpper
        - totalRunsInWindow
        - reviewCoverage
      additionalProperties: false
    ApiErrorIssue:
      type: object
      properties:
        field:
          type: string
          description: JSON path of the offending field, or "<root>"
        message:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: >-
            Machine-readable error code (e.g. invalid_value, not_found,
            api_trigger_disabled, manual_trigger_disabled)
        severity:
          type: string
          enum:
            - error
            - warning
          description: Issue severity
      required:
        - field
        - message
        - code
        - severity
      additionalProperties: false
    RunReviewHealthConfidence:
      type: object
      properties:
        lower:
          anyOf:
            - type: number
            - type: 'null'
        upper:
          anyOf:
            - type: number
            - type: 'null'
        method:
          type: string
          const: wilson
      required:
        - lower
        - upper
        - method
      additionalProperties: false
      description: >-
        Wilson score confidence interval for reviewed correctness. Null bounds
        mean there are no reviewed runs in the sample.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued from Settings → API Keys. Pass as `Authorization: Bearer
        <key>`.

````