Get live service metrics

Ten-second observed traffic rates in bits per second, UTC daily bytes and recorded proxy outcomes. Read last_activity_at for freshness; silence does not establish healthy idle traffic. Unavailable telemetry returns 503.

get/v1/services/{id}/live-metrics

Request

  • Base URL: https://api.trueproxies.com
  • URL: https://api.trueproxies.com/v1/services/{id}/live-metrics
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

customer_idstring uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Response

Observed metrics; sample freshness is independent of query freshness.

completed_connectionsinteger required

Recorded proxy outcomes underlying success_rate. Selected by event timestamp, not literal completion time; delayed or long-running connections can appear later.

connections_per_minuteinteger required

Sum of recorded usage connection deltas in the minute ending at window_end.

download_bpsnumber required

Customer download bits per second in the last complete series bucket, from bytes_out. Zero is an absence of recorded bytes, not proof of healthy idle traffic.

interval_seconds10 required
last_activity_atstring date-time nullable required

Latest non-system usage event before sampled_at, scanned since the earlier of midnight UTC or window_start. Null means no observation in that bounded interval. Samples are emitted only for activity; silence cannot distinguish idle traffic from unavailable collection. Treat current rates as unavailable when this is null or older than 60 seconds.

sampled_atstring date-time required

UTC query time; this does not prove collector health or data freshness.

success_ratenumber nullable required

Recorded proxy outcomes without a proxy error divided by recorded outcomes whose event timestamps fall in the minute ending at window_end. Outcomes that ended on the client side are not proxy errors; outcomes with no response are. These are proxy connection outcomes, not destination HTTP status. Null when no outcomes are recorded. Event timestamps may represent connection start rather than completion time.

traffic_today_bytesinteger required

Observed non-system upload plus download bytes from midnight UTC up to sampled_at; delayed arrivals may revise totals.

upload_bpsnumber required

Customer upload bits per second in the last complete series bucket, from bytes_in.

window_endstring date-time required

Exclusive UTC end, rounded down to ten seconds and delayed twenty seconds for collection and shipping. Later arrivals may revise observations.

window_startstring date-time required

Inclusive UTC start of the ten-minute rate series.

Changes

No recorded changes to this operation across all 1 revision of this API.