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

# Check Domain Health

> Check whether Nimble is seeing healthy traffic to one or more domains right now, sourced from real request outcomes across Search, SERP, ecommerce, and Extract traffic.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/domain-health/check
openapi: 3.1.0
info:
  title: Nimble SDK
  version: 1.0.0
  description: The AI-Native SDK for Real-Time Web Data at scale
servers:
  - url: https://sdk.nimbleway.com
security: []
paths:
  /v1/domain-health/check:
    post:
      tags:
        - Domain Health
      summary: Check Domain Health
      description: >-
        Check whether Nimble is seeing healthy traffic to one or more domains
        right now, sourced from real request outcomes across Search, SERP,
        ecommerce, and Extract traffic.
      operationId: check_domain_health
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainHealthCheckPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainHealthCheckResponse'
          description: Successful Response
      security:
        - BearerAuth: []
components:
  schemas:
    DomainHealthCheckPayload:
      description: Request body model for the domain health check endpoint
      properties:
        domains:
          description: >-
            Domains to check, 1-100 per request. Pass the bare domain (e.g.
            "walmart.com"), not a full URL.
          items:
            type: string
          maxItems: 100
          minItems: 1
          title: Domains
          type: array
      required:
        - domains
      title: DomainHealthCheckPayload
      type: object
    DomainHealthCheckResponse:
      description: Response model for the domain health check endpoint
      properties:
        domains:
          description: One entry per requested domain, in the order requested.
          items:
            $ref: '#/components/schemas/DomainHealthEntry'
          title: Domains
          type: array
      required:
        - domains
      title: DomainHealthCheckResponse
      type: object
    DomainHealthEntry:
      description: Live status and trailing 6-hour trend for a single domain.
      properties:
        domain:
          description: The domain checked.
          title: Domain
          type: string
        status:
          description: >-
            Live status: 'up' (healthy), 'degraded' (1-2 consecutive bad
            windows), 'down' (3+ consecutive bad windows), or 'unknown' (fewer
            than 10 samples in the lookback window).
          enum:
            - up
            - degraded
            - down
            - unknown
          title: Status
          type: string
        success_rate:
          description: Success rate over the live detection window.
          title: Success Rate
          type: number
        consecutive_bad_windows:
          description: Consecutive 10-minute windows below the success threshold.
          title: Consecutive Bad Windows
          type: integer
        history:
          description: 6 hourly buckets, most recent completed hour first.
          items:
            $ref: '#/components/schemas/DomainHealthHistoryBucket'
          title: History
          type: array
      required:
        - domain
        - status
        - success_rate
        - consecutive_bad_windows
        - history
      title: DomainHealthEntry
      type: object
    DomainHealthHistoryBucket:
      description: One hourly bucket in a domain's trailing 6-hour trend.
      properties:
        hours_ago:
          description: >-
            0 is the latest completed UTC hour, not the in-progress current
            hour.
          title: Hours Ago
          type: integer
        window_start:
          title: Window Start
          type: string
        window_end:
          title: Window End
          type: string
        status:
          description: >-
            'up' or 'down' for this hour's own traffic, using the same threshold
            as live status. No consecutive-window logic at this granularity.
          enum:
            - up
            - down
          title: Status
          type: string
        success_rate:
          title: Success Rate
          type: number
      required:
        - hours_ago
        - window_start
        - window_end
        - status
        - success_rate
      title: DomainHealthHistoryBucket
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````