---
title: "Check Domain Health"
method: POST
path: "/v1/domain-health/check"
tags: ["Domain Health"]
---

# Check Domain Health

`POST /v1/domain-health/check`

## Request

- Base URL: `https://sdk.nimbleway.com`
- URL: `https://sdk.nimbleway.com/v1/domain-health/check`
- Auth: HTTP bearer

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.

## Request body

- DomainHealthCheckPayload: Request body model for the domain health check endpoint
  - `domains` string[], required: Domains to check, 1-100 per request. Pass the bare domain (e.g. "walmart.com"), not a full URL.

## Response `200`

Successful Response

- DomainHealthCheckResponse: Response model for the domain health check endpoint
  - `domains` DomainHealthEntry[], required: One entry per requested domain, in the order requested.
    - `domain` string, required: The domain checked.
    - `status` 'up' | 'degraded' | 'down' | 'unknown', required: 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).
    - `success_rate` number, required: Success rate over the live detection window.
    - `consecutive_bad_windows` integer, required: Consecutive 10-minute windows below the success threshold.
    - `history` DomainHealthHistoryBucket[], required: 6 hourly buckets, most recent completed hour first.
      - `hours_ago` integer, required: 0 is the latest completed UTC hour, not the in-progress current hour.
      - `window_start` string, required
      - `window_end` string, required
      - `status` 'up' | 'down', required: 'up' or 'down' for this hour's own traffic, using the same threshold as live status. No consecutive-window logic at this granularity.
      - `success_rate` number, required

## Changes

- **2026-11-03** `75720b84c9d7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nimbleway/apis/nimble-sdk/changes/v1/domain-health/check/post.md)

---

[API](https://skmtc.dev/nimbleway/apis/nimble-sdk.md) - [All operations](https://skmtc.dev/nimbleway/apis/nimble-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/nimbleway/apis/nimble-sdk/revisions/75720b84c9d7?raw)
