SOsoax
Analytics

Get traffic breakdown for proxy usage

Retrieve traffic (in GB) grouped by a dimension (package, proxy_type, tier, country, domain, or ingress_ip), as a series of interval buckets. When group_by=package, keys are package names. The date range may span at most 365 days. If interval is omitted it is chosen automatically from the range (< 24 h → hour, < 60 days → day, otherwise month). Explicit intervals are validated: hour needs a range of at most 24 hours, day between 24 hours and 180 days, month at least 60 days.

If the API key is restricted to specific packages, results (and any package_ids filter) are limited to those packages.

Requires the proxy:analytics:read scope.

post/v1/proxy/analytics/traffic

Request

Request body

from_datestring date-time required

Start of the query range (ISO 8601).

to_datestring date-time required

End of the query range (ISO 8601). At most 365 days after from_date.

group_by'package' | 'proxy_type' | 'tier' | 'country' | 'domain' | 'ingress_ip'

Allowed grouping dimensions for analytics queries.

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

Allowed time intervals for analytics aggregation.

package_idsstring[] nullable

Restrict results to these package IDs.

network_typesstring[] nullable

Restrict results to network types: residential and/or mobile.

tiersinteger[] nullable

Restrict results to tiers (1, 2, or 3).

countriesstring[] nullable

Restrict results to these ISO country codes.

target_addressesstring[] nullable

Restrict results to traffic sent to these domains.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.