Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Proxy Analytics

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

Query parameters

presetstring

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_startstring datetime

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

period_endstring datetime

End date for the analytics period. If not provided, defaults to current time.

hostnamestring

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

network'datacenter' | 'isp' | 'residential' | 'mobile'

Filter results by network type.

proxy_user_idstring

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

return_proxy_usersboolean

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

return_hostnamesboolean

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

return_networksboolean

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

sort_bystring

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

limitstring

Maximum number of results to return.

Response

Analytics breakdown successful.

messagestring

Example response

{
  "message": "Analytics breakdown successful"
}