Skip to content

API Reference / Proxy sessions

Count proxy sessions per filter option

Returns, for each requested facet field (health, assigned, enabled, country), how many sessions carry each value under the same SessionFilter as ListSessions, with the field's own filter left out. Drives a pool's endpoint filter flyout.

POST/proxies.v1.Proxies/GetSessionFacetCounts

Request body

application/jsonRequired

Request for the per value counts of up to 8 session facet fields under the same filter as ListSessions, so a pool's endpoint filter flyout shows how many endpoints each option would select.

fields?array<string>

The facet fields to count, at most 8.

Value in"SESSION_FACET_FIELD_HEALTH""SESSION_FACET_FIELD_ASSIGNED""SESSION_FACET_FIELD_ENABLED""SESSION_FACET_FIELD_COUNTRY""SESSION_FACET_FIELD_CITY"

filter?SessionFilter

The same filter as ListSessions. Each facet is counted with every other field applied but not its own.

Show attributes
assigned?boolean

True selects only sessions with at least one live account assignment, false only sessions with none. Unset includes both.

cities?array<string>

Exit cities to include, as the English city names the sessions report in health.exit_city, OR within the field. The empty string selects sessions whose city is not known. Empty includes sessions in every city.

countries?array<string>

Exit countries to include, as upper-case ISO 3166-1 alpha-2 codes, OR within the field. A session's country is health.exit_country when observed, otherwise the provider's country. Empty includes sessions in every country and sessions whose country is not known.

enabled?boolean

True selects only enabled sessions, false only disabled sessions. Unset includes sessions regardless of enabled state.

healths?array<string>

Health states to include. Empty includes sessions in every state.

Value in"SESSION_HEALTH_STATE_HEALTHY""SESSION_HEALTH_STATE_UNHEALTHY""SESSION_HEALTH_STATE_UNPROBED"

poolId?string

Optional pool id to limit results to a single pool. Unset includes sessions across all pools.

Format"byte" base64

query?string

Literal case-insensitive substring of the session's host, slot number or an assigned account name. Absent or empty matches every session.

Response body

application/json

Success

facets?array<SessionFacetCounts>

One entry per requested field, in request order.

Show attributes
counts?FacetFieldCounts

The values ordered by count descending then value, at most 50, with truncated set when more exist.

Show attributes
truncated?boolean

True when the field has more than 50 values, so the list shows only the 50 most common.

values?array<FacetValueCount>

The values and their counts, ordered by count descending then by value, at most 50.

Show attributes
count?string

Number of rows carrying the value under the facet's predicate. Returned as a JSON string to preserve integer precision.

Format"int64"

value?string

The value as the list rows carry it: an enum name, a base64 id or an account name, so a client maps it to a label exactly as it maps a row.

field?string

The facet field these counts are for.

Value in"SESSION_FACET_FIELD_HEALTH""SESSION_FACET_FIELD_ASSIGNED""SESSION_FACET_FIELD_ENABLED""SESSION_FACET_FIELD_COUNTRY""SESSION_FACET_FIELD_CITY"

curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/GetSessionFacetCounts" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "poolId": "AY+MISIifMyN3T09PT09PQ=="
    },
    "fields": [
      "SESSION_FACET_FIELD_HEALTH"
    ]
  }'
{
  "facets": [
    {
      "field": "SESSION_FACET_FIELD_HEALTH",
      "counts": {
        "values": [
          {
            "value": "SESSION_HEALTH_STATE_HEALTHY",
            "count": "16"
          },
          {
            "value": "SESSION_HEALTH_STATE_UNHEALTHY",
            "count": "2"
          }
        ],
        "truncated": false
      }
    }
  ]
}