Skip to content

API Reference / Proxy sessions

Get proxy session latency history

Returns the hourly health check latency of one proxy session over a window of up to 31 days: for each hour, the number of successful and failed checks and the smallest, average and largest time for a test request through the endpoint. Hours with no checks are left out.

POST/proxies.v1.Proxies/GetSessionLatencyHistory

Request body

application/jsonRequired

Request for the hourly health check latency of one proxy session in the caller's workspace over a window of at most 31 days.

sessionIdstring

Opaque 16-byte identifier of the session, base64-encoded in JSON.

Format"byte" base64

startedBefore?string

Exclusive end of the window. Absent reads up to the time of the request, so the current hour may be partial.

Format"date-time"

startedFrom?string

Inclusive start of the window, rounded down to the hour. Absent reads the 7 days before started_before. A window longer than 31 days is rejected with invalid_argument.

Format"date-time"

Response body

application/json

Success

buckets?array<SessionLatencyBucket>

Hours with at least one check, ordered by started_at ascending, at most 744.

Show attributes
average?string

Average round trip of the hour's successful checks. Absent when every check in the hour failed.

failureCount?integer

Number of failed checks in the hour. They carry no latency.

Format"int32"

maximum?string

Largest round trip of the hour's successful checks. Absent when every check in the hour failed.

minimum?string

Smallest round trip of the hour's successful checks. Absent when every check in the hour failed.

startedAt?string

Inclusive UTC start of the hour.

Format"date-time"

successCount?integer

Number of successful checks in the hour, the samples the latency figures summarise.

Format"int32"

windowEnd?string

Exclusive end of the window read.

Format"date-time"

windowStart?string

Inclusive start of the window read, on an hour boundary.

Format"date-time"

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/GetSessionLatencyHistory" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "AY+MIjMzfu6P/05OTk5OTg==",
    "startedFrom": "2026-11-10T00:00:00Z",
    "startedBefore": "2026-11-11T00:00:00Z"
  }'
{
  "windowStart": "2026-11-10T00:00:00Z",
  "windowEnd": "2026-11-11T00:00:00Z",
  "buckets": [
    {
      "startedAt": "2026-11-10T00:00:00Z",
      "successCount": 60,
      "minimum": "0.180s",
      "average": "0.240s",
      "maximum": "0.910s"
    }
  ]
}