Skip to content

API Reference / Proxy usage

Summarise requests through your proxies

Returns the figures and the chart over the same rows ListProxyRequests lists, for a window of the last 6 hours at most: requests and failures, connections opened and open now, the median and 95th percentile time, the bytes each way, the average split of the time into your side, the proxy and the site, and the requests in every bucket of the window.

POST/analytics.v1.Analytics/GetProxyRequestSummary

Request body

application/jsonRequired

Request for the figures and the chart over the same rows ListProxyRequests lists, over a window of the last 6 hours at most.

bucketWidth?string

Width of the chart's buckets. Unspecified picks one minute for a window of up to an hour, five minutes up to two hours, and fifteen minutes beyond.

Value in"PROXY_REQUEST_BUCKET_WIDTH_ONE_MINUTE""PROXY_REQUEST_BUCKET_WIDTH_FIVE_MINUTES""PROXY_REQUEST_BUCKET_WIDTH_FIFTEEN_MINUTES"

filter?ProxyRequestFilter

The window and which rows to count, the same filter as the list.

Show attributes
accountName?string

Steam account name, matched exactly.

destination?string

Destination, matched exactly: a host for a request (with its port only when it is not the usual one), a host and port or an address and port for a connection.

kind?string

Requests only or connections only. Absent covers both.

Value in"PROXY_REQUEST_KIND_REQUEST""PROXY_REQUEST_KIND_CONNECTION"

poolId?string

Opaque 16-byte identifier of a pool, base64-encoded in JSON.

Format"byte" base64

providerId?string

Opaque 16-byte identifier of a provider, base64-encoded in JSON.

Format"byte" base64

result?string

Succeeded only or failed only. Absent covers both.

Value in"PROXY_REQUEST_RESULT_SUCCEEDED""PROXY_REQUEST_RESULT_FAILED"

search?string

Text the account name, the destination or the path contains, ignoring case. Absent or empty matches every row.

sessionId?string

Opaque 16-byte identifier of one proxy (the proxies service's session), base64-encoded in JSON.

Format"byte" base64

startedBefore?string

Exclusive end of the window. Absent means the time of the request. A list's later pages keep the end of its first page, so they never shift. Send the same explicit window to the list and the summary to have both count the same rows.

Format"date-time"

startedFrom?string

Inclusive start of the window. Absent means 6 hours before started_before. A start more than 6 hours ago is rejected with invalid_argument: older rows are kept only to rebuild the rollup.

Format"date-time"

Response body

application/json

Success

averageTimings?ProxyRequestTimings

Average split of the window's successful timed requests into our side, the proxy and the site (only ours, proxy, site and unmeasured are set). Absent when no request in the window was timed.

Show attributes
connectionWait?string

Waiting for a connection, or for an idle one to be handed over. Our side.

download?string

Downloading the response, from its first byte to its end. The site.

firstByteWait?string

Waiting for the site's first byte. The site.

ours?string

Our side: connection_wait.

proxy?string

The proxy: proxy_lookup, proxy_connect, proxy_sign_in and proxy_tunnel.

proxyConnect?string

Connecting to the proxy itself (its name looked up when given by name, and the TCP connect). The proxy.

proxyLookup?string

Looking up the proxy's own name, when it is given by name (a provider's gateway). Absent when the proxy is given by address. When present, proxy_connect is the TCP connect alone. The proxy.

proxySignIn?string

Signing in to a SOCKS5 proxy: the greeting and the username and password exchange. Absent for an HTTP CONNECT proxy, whose credentials travel with its connect request, and for rows recorded before 13 November 2026. When present, proxy_tunnel is the proxy reaching the site alone. The proxy.

proxyTunnel?string

The proxy connecting to the site: the CONNECT or SOCKS5 handshake, which includes the proxy's own lookup of the site's name. The proxy.

requestWrite?string

Sending the request. The site.

site?string

The site: tls_handshake, request_write, first_byte_wait and download.

tlsHandshake?string

The TLS handshake with the site through the proxy. The site.

unmeasured?string

The rest of the whole duration that no phase covers (reading the response headers, scheduling). Absent when the phases cover it.

buckets?array<ProxyRequestBucket>

Every bucket of the window in time order, including empty ones.

Show attributes
bytesIn?string

Bytes received in the bucket, a connection's counted when reported.

Format"int64"

bytesOut?string

Bytes sent in the bucket, a connection's counted when reported.

Format"int64"

connectionCount?string

Connection dials that started in the bucket, apart from request_count.

Format"int64"

failedConnectionCount?string

Of those, the ones that failed to open.

Format"int64"

failedRequestCount?string

Of those, the ones that failed.

Format"int64"

medianDuration?string

Median whole duration of the bucket's successful requests (approximate). Absent with none.

requestCount?string

Requests that started in the bucket, not counting connection dials.

Format"int64"

startedAt?string

Start of the bucket, on a multiple of its width in UTC.

Format"date-time"

bytesIn?string

Bytes received in the window.

Format"int64"

bytesOut?string

Bytes sent in the window.

Format"int64"

connectionCount?string

Connection dials that started in the window.

Format"int64"

failedConnectionCount?string

Of those, the ones that failed to open.

Format"int64"

failedRequestCount?string

Of those, the ones that failed.

Format"int64"

medianDuration?string

Median whole duration of the window's successful requests (approximate). Absent with none.

openConnectionCount?string

Connections open now under the filter's provider, pool, proxy, account, destination and search, whenever they opened: reported within the last 10 minutes and not closed.

Format"int64"

p95Duration?string

95th percentile of the same (approximate). Absent with none.

requestCount?string

Requests that started in the window.

Format"int64"

windowEnd?string

Exclusive end of the window read.

Format"date-time"

windowStart?string

Inclusive start of the window read.

Format"date-time"

curl -X POST "https://api.goldmine.to/analytics.v1.Analytics/GetProxyRequestSummary" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "startedFrom": "2026-11-12T18:00:00Z",
      "startedBefore": "2026-11-12T18:30:00Z",
      "poolId": "AZrEoUhh/X+4C3EJAhYjqg=="
    },
    "bucketWidth": "PROXY_REQUEST_BUCKET_WIDTH_FIFTEEN_MINUTES"
  }'
{
  "windowStart": "2026-11-12T18:00:00Z",
  "windowEnd": "2026-11-12T18:30:00Z",
  "requestCount": "200",
  "failedRequestCount": "5",
  "connectionCount": "4",
  "openConnectionCount": "4",
  "medianDuration": "0.270s",
  "p95Duration": "0.910s",
  "bytesOut": "412000",
  "bytesIn": "6200000",
  "buckets": [
    {
      "startedAt": "2026-11-12T18:00:00Z",
      "requestCount": "96",
      "failedCount": "2",
      "bytesOut": "200000",
      "bytesIn": "3000000"
    },
    {
      "startedAt": "2026-11-12T18:15:00Z",
      "requestCount": "108",
      "failedCount": "3",
      "bytesOut": "212000",
      "bytesIn": "3200000"
    }
  ],
  "averageTimings": {
    "ours": "0.001s",
    "proxy": "0.020s",
    "site": "0.240s"
  }
}