Skip to main content
POST
Get traffic breakdown for proxy usage

Authorizations

Authorization
string
header
required

API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.

Body

application/json

Request model for traffic breakdown analysis.

from_date
string<date-time>
required

Start of the query range (ISO 8601).

to_date
string<date-time>
required

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

group_by
enum<string>
default:package

Allowed grouping dimensions for analytics queries.

Available options:
package,
proxy_type,
tier,
country,
domain,
ingress_ip
interval
enum<string> | null

Bucket size for the series. Auto-selected from the range when omitted (< 24 h → hour, < 60 days → day, otherwise month).

Available options:
hour,
day,
month
package_ids
string[] | null

Restrict results to these package IDs.

network_types
string[] | null

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

tiers
integer[] | null

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

countries
string[] | null

Restrict results to these ISO country codes.

target_addresses
string[] | null

Restrict results to traffic sent to these domains.

Response

Successful Response

data
TrafficDataPoint · object[]
required