Analytics Breakdown

This endpoint analyzes proxy usage for a given customer within a specified time range and provides breakdowns by proxy users, hostnames, and network types.

You can either:

1. Provide a “preset” parameter, which automatically sets the time period (e.g. “last_day”, “last_hour”, etc.).
2. OR, manually specify your own time range using period_start and period_end.

You can also filter by hostname, network, and proxy_user_id. Hostname filters are disallowed if searching older than 90 days.

GET /public/user/analytics/breakdown

Analytics Breakdown

cURL

curl --request GET \
  --url https://api.byteful.com/1.0/public/user/analytics/breakdown \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'

200

{
  "data": {
    "hostnames": [
      {
        "bytes": 123,
        "hostname": "<string>",
        "requests": 123
      }
    ],
    "networks": [
      {
        "bytes": 123,
        "network": "datacenter",
        "requests": 123
      }
    ],
    "proxy_user_ids": [
      {
        "bytes": 123,
        "proxy_user_id": "<string>",
        "requests": 123
      }
    ],
    "total_bytes": 123,
    "total_requests": 123
  },
  "message": "Analytics breakdown successful"
}

Authorizations

X-API-Private-Key · string · header · required

Private API key for user-level authentication.

X-API-Public-Key · string · header · required

Public API key for user-level authentication.

Query Parameters

preset · string

If provided, overrides period_start and period_end. Must be one of ["last_hour", "last_day", "last_week", "last_30_days", "last_60_days", "last_90_days", "last_year"].

period_start · string<datetime>

Start date for the analytics period. If not provided, defaults to 7 days ago.

period_end · string<datetime>

End date for the analytics period, inclusive. Date-only values (e.g. 2026-07-29) cover that entire day. If not provided, defaults to current time.

hostname · string

Filter results by specific hostname. Cannot be used for data older than 90 days.

network · enum<string>

Filter results by network type.

Available options: datacenter, isp, residential, mobile

proxy_user_id · string

Filter results by proxy user ID. Must belong to the current customer.

return_proxy_users · boolean

Whether to include proxy user data in response. Defaults to true.

return_hostnames · boolean

Whether to include hostname data in response. Defaults to true.

return_networks · boolean

Whether to include network data in response. Defaults to true.

sort_by · string

Field to sort results by, with optional _asc or _desc suffix to specify direction.

limit · string

Maximum number of results to return.

Response

200 - application/json

Analytics breakdown successful.

data · object

Show child attributes

message · string

Example:

"Analytics breakdown successful"