Stats — GET /v1/stats · Docs

Stats

Platform infrastructure health for an engine or path over the last hour. Free.

GEThttp://localhost:4000/v1/stats

Authenticate with the x-api-key header. See authentication and credits & billing.

Parameters

Parameter	Description
`engine` string	API family, e.g. capture, content, analyze, website.
`path` string	Specific endpoint path, e.g. /v1/capture.

curl "http://localhost:4000/v1/stats?engine=capture" \
  -H "x-api-key: $SNAPLENS_API_KEY"

200 — application/json

{
  "engine": "capture",
  "path": null,
  "health": "operational",
  "success_rate": 99.4,
  "avg_response_time_ms": 1184,
  "window": "1h"
}

Pass either engine (an API family: capture, content, analyze, website) or path (a specific endpoint such as /v1/capture).

Field	Type	Description
`engine`	string \| null	Engine queried.
`path`	string \| null	Path queried.
`health`	string	`operational`, `degraded` or `down`.
`success_rate`	number	Percentage of successful requests across the platform.
`avg_response_time_ms`	number	Average response time in milliseconds.
`window`	string	Always `"1h"` — the last hour.

Use it to route traffic, pause batch jobs or show a banner in your app. The public status page shows the same data.

Stats access must be enabled for your workspace. If it isn't, the endpoint returns 403 — contact support to enable it.

Errors return JSON { "error": "…" }. Failed requests are never billed. Full list in Status codes.

Status	Meaning
400	Neither or an invalid `engine` / `path`
401	Invalid, inactive or expired API key; plan rate limit (`Rate limit exceeded: …`) or key quota (`…: quota daily`)
403	Stats are not enabled for your account, or IP temporarily blocked
500	Unexpected server error