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

# Overview step catalog

> Step catalog from finished runs of the Head revision in the window, with first-try and flake aggregates. Empty when the monitor has no step catalog.



## OpenAPI

````yaml /openapi/monitoring-api.json get /api/v1/monitors/{id}/overview/steps
openapi: 3.0.1
info:
  title: DevHelm API
  description: >-
    DevHelm monitoring and incident management API. Create and manage uptime
    monitors, incidents, alert channels, notification policies, and more.
  version: '1.0'
  contact:
    name: DevHelm
    url: https://devhelm.io
    email: support@devhelm.io
servers:
  - url: https://api.devhelm.io
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Alert Channels
    description: Alert channel CRUD and connectivity testing
  - name: Alert Deliveries
    description: 'Delivery audit trail: inspect per-attempt details for alert deliveries'
  - name: API Auth
    description: Identity and quota info for API key authentication
  - name: API Keys
    description: Organization API key management
  - name: Artifacts
    description: Run evidence file content
  - name: Audit Log
    description: Organization audit trail
  - name: Check Results
    description: Query raw check results, uptime statistics, and summary data
  - name: Dashboard
    description: Overview dashboard aggregates
  - name: Definitions
    description: Code-monitor definition catalog and revisions
  - name: Deploy Lock
    description: Mutex for CLI deploy operations
  - name: Environments
    description: Variable namespace management for monitors
  - name: Forensics
    description: >-
      Detection engine event-sourced history (policy snapshots, rule
      evaluations, state transitions)
  - name: Heartbeat
    description: Public ping endpoint for heartbeat monitors
  - name: Incident Policies
    description: Manage trigger, confirmation, and recovery rules for monitors
  - name: Incidents
    description: Incident management and lifecycle
  - name: Integrations
    description: Static catalog of supported alert channel integrations
  - name: Invites
    description: Organization invite management
  - name: Maintenance Windows
    description: Schedule alert-suppression windows for monitors
  - name: Members
    description: Organization member management
  - name: Monitor Alert Channels
    description: Manage alert channel mappings for a monitor
  - name: Monitor Assertions
    description: Manage assertions for a monitor
  - name: Monitor Auth
    description: Manage authentication configuration for a monitor
  - name: Monitor definitions
    description: Publish, rollback, and revision history for code monitors
  - name: Monitor Runs
    description: Per-monitor code run history and run-now
  - name: Monitor secret requests
    description: Secret keys a monitor requires and how they are fulfilled
  - name: Monitor session
    description: Cached sign-in session for a monitor
  - name: Monitors
    description: Monitor CRUD and lifecycle management
  - name: Notification Dispatches
    description: >-
      Dispatch debugging API: inspect which policies matched an incident and
      track delivery status
  - name: Notification Policies
    description: Org-level notification routing policies with JSONB match rules
  - name: Notifications
    description: In-app notification center
  - name: Organizations
    description: Organization management
  - name: Resource Groups
    description: Resource group CRUD and member management
  - name: Revisions
    description: Definition revision packages
  - name: Runs
    description: Code-monitor run list, snapshot, cases, events, and cancel
  - name: Secrets
    description: Organization environment secret management
  - name: Service Subscriptions
    description: Manage which services an organization tracks
  - name: Status Data
    description: Public service status catalog, components, uptime, and incident history
  - name: Status Pages
    description: Status page management
  - name: Tags
    description: Org-scoped tag management for monitors
  - name: Vault
    description: Organization vault management (admin-only)
  - name: Webhooks
    description: Webhook endpoint management, event catalog, and delivery history
  - name: Workspaces
    description: Workspace management within an organization
paths:
  /api/v1/monitors/{id}/overview/steps:
    get:
      tags:
        - Check Results
      summary: Overview step catalog
      description: >-
        Step catalog from finished runs of the Head revision in the window, with
        first-try and flake aggregates. Empty when the monitor has no step
        catalog.
      operationId: getMonitorOverviewSteps
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: window
          in: query
          description: Time window for step aggregates
          required: false
          schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - 90d
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SingleValueResponseOverviewStepsDto'
        '400':
          description: Bad request — the payload failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized — missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden — the actor lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found — the requested resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — the request collides with current resource state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error — see the message field for details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad gateway — an upstream provider returned an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service unavailable — try again shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SingleValueResponseOverviewStepsDto:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OverviewStepsDto'
    ErrorResponse:
      required:
        - code
        - message
        - status
        - timestamp
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code (mirrors the response status line)
          format: int32
          example: 404
        code:
          type: string
          description: >-
            Coarse machine-readable error category (e.g. NOT_FOUND,
            RATE_LIMITED); stable per status
          example: NOT_FOUND
        message:
          type: string
          description: Human-readable error message; safe to surface to end users
          example: Monitor not found
        timestamp:
          type: integer
          description: Server time when the error was produced (epoch milliseconds)
          format: int64
          example: 1737302400000
        requestId:
          type: string
          description: >-
            Opaque per-request id; same value as the X-Request-Id response
            header. Use in support tickets.
          nullable: true
          example: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
        errors:
          type: array
          description: >-
            Structured per-field rejections; populated for validation errors,
            null otherwise
          nullable: true
          items:
            nullable: true
            allOf:
              - $ref: '#/components/schemas/ErrorEntry'
      description: Uniform error envelope returned for every non-2xx response
      example:
        status: 404
        code: NOT_FOUND
        message: Monitor not found
        timestamp: 1737302400000
        requestId: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
    OverviewStepsDto:
      required:
        - steps
      type: object
      properties:
        steps:
          type: array
          description: Rows in revision order; empty when the monitor has no step catalog
          items:
            $ref: '#/components/schemas/OverviewStepDto'
      description: Overview step catalog joined to run-step aggregates
    ErrorEntry:
      required:
        - code
        - message
      type: object
      properties:
        code:
          minLength: 1
          type: string
          description: >-
            Stable machine-readable code; see ValidationErrorCode for the
            registry
          example: MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL
        field:
          type: string
          description: >-
            JSON-pointer-like path to the offending field, or null for
            request-wide errors
          nullable: true
          example: config.gracePeriod
        message:
          minLength: 1
          type: string
          description: Human-readable message; safe to surface to end users
      description: One structured validation rejection
    OverviewStepDto:
      required:
        - cells
        - name
        - index
        - failed
      type: object
      properties:
        index:
          type: integer
          description: 0-based step index from the Head revision catalog
          format: int32
        name:
          minLength: 1
          type: string
          description: Step title from the Head revision catalog
        p50Ms:
          type: number
          description: Median duration in ms; null until the step has settled timings
          format: double
          nullable: true
        p95Ms:
          type: number
          description: p95 duration in ms; null until the step has settled timings
          format: double
          nullable: true
        failed:
          type: integer
          description: Failed first-attempt count in the window
          format: int64
        firstTryPercent:
          type: number
          description: First-try pass percent for this step; null when no settled attempts
          format: double
          nullable: true
        flakeRetries:
          type: integer
          description: Retry attempts on this step; null when none
          format: int32
          nullable: true
        cells:
          type: array
          description: Last 30 outcomes for this step, oldest first
          items:
            $ref: '#/components/schemas/OverviewStepCellDto'
        expected:
          type: string
          description: Assertion expected from the latest failure
          nullable: true
        received:
          type: string
          description: Assertion received from the latest failure
          nullable: true
        error:
          type: string
          description: Error text from the latest failure
          nullable: true
        region:
          type: string
          description: Region of the latest failure
          nullable: true
        failedAt:
          type: string
          description: When the latest failure settled
          nullable: true
        latestFailedRunId:
          type: string
          description: Run that produced the latest failure
          format: uuid
          nullable: true
      description: One catalog step on the monitor overview table
    OverviewStepCellDto:
      required:
        - id
        - outcome
      type: object
      properties:
        id:
          type: string
          description: Stable cell id
        outcome:
          minLength: 1
          type: string
          description: Step outcome for that run
        at:
          type: string
          description: When that step settled
          nullable: true
      description: One cell on the overview step last-30 strip
  securitySchemes:
    BearerAuth:
      type: http
      description: API key (dh_live_...) or Auth0 JWT token
      scheme: bearer
      bearerFormat: JWT

````