Stats

Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant.

The Stats endpoint returns a single infrastructure health snapshot for an API engine or a specific path. Metrics are aggregated across the whole platform over a one-hour window. They are not your account or tenant usage. There is no hourly time series. Use Usage for your account quota.

This endpoint is free. It never consumes any credits.

These are infrastructure stats for the platform, not stats for your account or tenant. Every authenticated caller sees the same health snapshot. For remaining credits and rate limits, use Usage.

Query parameters

Provide at least one of engine or path.

engine (string): API family to check, for example linkedin or google.
path (string): specific endpoint to check, for example /v1/linkedin/profile-info. If you also pass engine, use an endpoint from that API.

Request

curl "https://api.huntapi.com/v1/stats?engine=linkedin" \
  -H "x-api-key: YOUR_API_KEY"

curl "https://api.huntapi.com/v1/stats?path=/v1/linkedin/profile-info" \
  -H "x-api-key: YOUR_API_KEY"

Health values

operational: success rate at or above 99%.
degraded: success rate from 90% up to 99%.
down: success rate below 90%.

Response Fields

Field	Type	Description
`engine`	`string`	Engine slug derived from the catalog (for example `linkedin`)
`path`	`string \| null`	Normalized path filter, or `null` when you query by engine only
`health`	`string`	`operational`, `degraded`, or `down` for the last hour
`success_rate`	`number`	Success rate over the last hour. Only HTTP 5xx counts as failure. Low-volume windows are smoothed.
`avg_response_time_ms`	`integer`	Average response time in milliseconds. Durations above 60 seconds are excluded.
`window`	`string`	Aggregation window. Always `1h`.

The response does not include request volume, raw error counts, or any account-level or tenant-level data.

Example Response

{
  "engine": "linkedin",
  "path": "/v1/linkedin/profile-info",
  "health": "operational",
  "success_rate": 99.412,
  "avg_response_time_ms": 840,
  "window": "1h"
}

Errors

Code	Description
`400`	Missing `engine` and `path`, invalid value, or path that does not match `engine`
`401`	Missing or invalid API key
`404`	Unknown engine (not in the API catalog)
`503`	Status data is temporarily unavailable

See also: Usage for your account quota (tenant-scoped), Status Codes for HTTP billing rules, and Error Handling for integration errors.