Hanzo
OpenapiGateway

Report who is calling this org's API right now

Traffic reports who is calling this organization's API right now: the request count for the last minute split by AGENCY LANE — agent, human, bot, unknown…

GET /v1/gateway/traffic

Addresshttps://api.hanzo.ai/v1/gateway/traffic
MethodGET
OperationgatewayTraffic
AuthAuthorization: Bearer $HANZO_API_KEY

Traffic reports who is calling this organization's API right now: the request count for the last minute split by AGENCY LANE — agent, human, bot, unknown — and the busiest callers behind it, each with its request count, its authentication-failure count, how many distinct paths it touched, and any verdict currently held against it.

The lane split is the answer to the question a generic bot filter cannot answer: which of this traffic is the customer's own automation and which is somebody working through a list. It is computed from credentials we issued, not from the client's self-description, so a scraper cannot move itself into the agent lane by editing a header.

A validated caller appears as a FINGERPRINT — a one-way, per-process digest. It is stable enough to recognise the same caller across a minute and cannot be turned back into a key, so this report is safe to read, screenshot and paste.

It also reports what the sensor's own ceilings are doing (strain, tracked, ceiling, refused) and how many screens the scorer did not answer (unscored), so a control that has stopped measuring or a judge that has stopped answering is a number here rather than a quiet day.

Scoped to the caller's own validated organization. A SuperAdmin may inspect a specific tenant with ?org=<slug>, or the lane that has no tenant — every caller the identity boundary could not validate — with an empty ?org=.

Request

GET /v1/gateway/traffic takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200TrafficViewok

200 body — 22 fields.

FieldInTypeAlwaysDescription
blindbodyintegerBlind is how many requests in the window carried no identity to attribute them to — no validated credential and no client address.
callersbodyTrafficCaller[]Callers is the scope's busiest callers this window.
callers[].actionbodystringAction is the verdict currently held against it, if any.
callers[].credbodystringCred is the caller's key: a credential fingerprint (a per-process one-way digest, not a key) for a validated caller, and "ip:<addr>" for one that presented no…
callers[].failuresbodyintegerFailures is how many ended 401 or 403.
callers[].held_untilbodyintegerHeldUntil is when the held verdict lapses, unix seconds.
callers[].pathsbodyintegerPaths is the approximate number of distinct paths it touched (max 64).
callers[].reasonbodystringReason is why that verdict was reached.
callers[].requestsbodyintegerRequests is its request count in the window.
ceilingbodyintegerCeiling is the most callers this scope may hold at once.
deniedbodyintegerDenied is how many of them the gate refused.
lanesbodyobjectLanes is the request count per lane — agent, human, bot, unknown.
lanes.*bodyinteger
modebodystringMode is the abuse gate's posture for this scope: "shadow" records the scorer's action without enforcing it, "live" enforces it.
orgbodystringOrg is the scope this view was taken for — the validated principal's own, never a value the caller supplied.
refusedbodyintegerRefused is how many callers this scope's ceilings turned away in the window.
requestsbodyintegerRequests is how many requests this scope made in the window.
screensbodyintegerScreens is how many of them were put to the scorer — the billable unit of the risk product.
strainbodystringStrain is what this scope's ceilings are doing: "clear" below them, "full" at them, "refuse" once a caller has been turned away inside this window — which…
trackedbodyintegerTracked is how many callers this scope holds state for right now, and Ceiling is the most it may hold.
unscoredbodyintegerUnscored is how many of those screens got NO answer — the scorer was absent, stuck, slow, erroring or silent.
window_secbodyintegerWindowSec is the span the counts cover, in seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo gateway traffic

Gateway API · All Hanzo APIs · Interactive reference

How is this guide?

On this page