v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Proxy Analytics

Graph Proxy Analytics

This endpoint analyzes proxy usage for a given customer within a specified time range and groups them by one of four discrete intervals: minute, hour, day, or month.

You can either

Provide a preset parameter, which automatically sets period and interval (e.g. last_day, last_hour, etc.)
OR, manually specify your own time range (period_start, period_end) plus interval

You can also filter by hostname, network, proxy_user_id, and service_id. Service ID can only be filtered if period is within 7 days and interval is hour or less. Hostname filters are disallowed if searching older than 90 days.

get/public/user/analytics/graph

Query parameters

presetstring

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

period_startstring datetime

period_endstring datetime

interval'minute' | 'hour' | 'day' | 'month'

hostnamestring

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

proxy_user_idstring

service_idstring

show_log_concurrencyboolean

If true, includes avg_log_concurrency and max_log_concurrency per interval bucket and total_avg_log_concurrency and total_max_log_concurrency for the period. Only valid when interval is minute or hour (raw log data). Returns 422 for day or month intervals.

Response

Analytics graphing successful.

messagestring

A success message.

Example response

{
  "data": {
    "intervals": [
      {
        "bytes": 1102393,
        "interval": "2025-02-27 13:02:00",
        "interval_name": "2025-02-27 13:02:00",
        "requests": 266,
        "successful": 266
      }
    ],
    "total_bytes": 1102393,
    "total_requests": 266,
    "total_successful": 266
  },
  "message": "Analytics graphing successful."
}