Skip to content
TrueProxies Docs

Get account analytics

GET
/v1/analytics
curl --request GET \
  --url 'https://api.trueproxies.com/v1/analytics?range=24h' \
  --header 'Authorization: Bearer <token>'

Analytics across the services owned by this account.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
customer_id
string format: 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.

range
string
default: 24h
Allowed values: 24h 7d 30d

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
destinations
required
Array<object>
object
bytes
required
integer format: int64
failures
required

Outcomes with a proxy error, including no_response and excluding outcomes that ended on the client side.

integer format: int64
host
required
string
requests
required
integer format: int64
errors
required

Outcome counts by class. Proxy errors use their error class, plus no_response for outcomes recorded without an error in which the client sent a request after proxy setup and received nothing beyond the setup reply. client_reset (the client side reset the connection) and client_left_open (the client side kept the connection open after the destination finished) are listed here but are not failures.

Array<object>
object
count
required
integer format: int64
err_class
required

Error class, or no_response, client_reset or client_left_open as described in Analytics errors.

string
range
required
string
series
required
Array<object>
object
avg_session_ms

Mean elapsed milliseconds of measured completed authenticated socket sessions; null when no samples exist.

number | null
avg_setup_ms

Mean gateway-to-destination setup milliseconds for measured successful initial TCP tunnels; null when no samples exist.

number | null
bytes_in
required
integer format: int64
bytes_out
required
integer format: int64
failures
required

Outcomes with a proxy error, including no_response and excluding outcomes that ended on the client side.

integer format: int64
requests
required
integer format: int64
session_samples

Number of measured completed session samples in this bucket.

integer
setup_samples

Number of measured successful setup samples in this bucket.

integer
ts
required
string format: date-time
success_rate
required

Share of recorded proxy connection outcomes without a proxy error. Outcomes that ended on the client side (client_reset and client_left_open in errors) are not proxy errors; no_response is. This is not destination HTTP status.

number
Examplegenerated
{
  "destinations": [
    {
      "bytes": 1,
      "failures": 1,
      "host": "example",
      "requests": 1
    }
  ],
  "errors": [
    {
      "count": 1,
      "err_class": "example"
    }
  ],
  "range": "example",
  "series": [
    {
      "avg_session_ms": 1,
      "avg_setup_ms": 1,
      "bytes_in": 1,
      "bytes_out": 1,
      "failures": 1,
      "requests": 1,
      "session_samples": 1,
      "setup_samples": 1,
      "ts": "2026-04-15T12:00:00Z"
    }
  ],
  "success_rate": 1
}

400

Section titled “400”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

401

Section titled “401”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

403

Section titled “403”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

404

Section titled “404”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

409

Section titled “409”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

429

Section titled “429”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

500

Section titled “500”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}

503

Section titled “503”

Error

Media typeapplication/json
object
code
required
string
Allowed values: BAD_REQUEST UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE OFFER_UNAVAILABLE CITY_UNAVAILABLE CAPACITY_UNAVAILABLE INVOICE_NOT_PAYABLE PROVIDER_ERROR PIPE_UNAVAILABLE TRIAL_NOT_ELIGIBLE EMAIL_UNVERIFIED INTERNAL
details

What a client needs to act on the error (ids, flags), never display text.

object
key
additional properties
any
message
required
string
Example
{
  "code": "BAD_REQUEST"
}