GET /v1/health

Public, unauthenticated endpoint. Returns 7-day rolling success rate + p95 latency for each platform supported by /v1/check. Use this to surface a status badge in your dashboard or to gate canary deployments.

GET/v1/health

Pricing — free

No charge. No auth. KV-cached 60s, so polling at 1Hz is fine. Rate limit: 60 req/min per IP.

Quickstart

bash
curl https://api.mentionsapi.com/v1/health

Response

json
{
  "platforms": {
    "chatgpt":    { "status": "operational", "success_rate_7d": 0.9942, "p95_latency_ms": 4180, "target_success_rate": 0.99, "target_p95_latency_ms": 5000, "sample_size_7d": 2148 },
    "claude":     { "status": "operational", "success_rate_7d": 0.9961, "p95_latency_ms": 3920, "target_success_rate": 0.99, "target_p95_latency_ms": 5000, "sample_size_7d": 2148 },
    "gemini":     { "status": "operational", "success_rate_7d": 0.9907, "p95_latency_ms": 4780, "target_success_rate": 0.99, "target_p95_latency_ms": 5000, "sample_size_7d": 2148 },
    "perplexity": { "status": "operational", "success_rate_7d": 0.9550, "p95_latency_ms": 7120, "target_success_rate": 0.95, "target_p95_latency_ms": 8000, "sample_size_7d": 2148 }
  },
  "fetched_at": "2026-04-25T12:00:00Z",
  "methodology_url": "https://mentionsapi.com/methodology"
}

Status values

FieldTypeDescription
operationaloptional
stringsuccess_rate_7d ≥ target_success_rate. The platform is hitting its SLA.
degradedoptional
stringsuccess_rate_7d in [target - 0.10, target). Within 10pp of SLA — keep polling but expect intermittent failures.
downoptional
stringsuccess_rate_7d < target - 0.10. Below 10pp of SLA. Triggers our SLA-credit policy automatically.
unknownoptional
stringsample_size_7d < 20. Not enough data to form an honest opinion. Returned during low-traffic windows or after an outage flush.

Field reference

FieldTypeDescription
platforms[name].statusoptional
stringoperational | degraded | down | unknown.
platforms[name].success_rate_7doptional
number | null0–1. Null when sample_size is below the unknown threshold.
platforms[name].p95_latency_msoptional
number | null95th percentile of call-level latency_ms over the 7-day window.
platforms[name].target_success_rateoptional
numberPublished SLA target. See /methodology for how we set these.
platforms[name].target_p95_latency_msoptional
numberPublished SLA latency target.
platforms[name].sample_size_7doptional
numberNumber of usage_events rows that touched this platform in the window.
fetched_atoptional
string (ISO 8601)When this snapshot was rendered. Snapshot is cached 60s, so values can lag up to that long.
methodology_urloptional
string (URL)Link to the methodology doc — surface this on your status badge so customers can verify.