Skip to content

Get traffic totals over time

GET
/analytics/overall
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/analytics/overall?end=2026-07-01T00%3A00%3A00Z&include_sub_users=true&package_id=550e8400-e29b-41d4-a716-446655440002&start=2026-07-01T00%3A00%3A00Z&timezone=UTC&user_id=550e8400-e29b-41d4-a716-446655440001' \
--header 'Accept-Language: de' \
--header 'Authorization: Bearer <token>'

Returns transferred bytes and request counts grouped into time buckets for charts and usage reporting.

end
string

Exclusive end of the reporting window. Defaults to the current time. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling.

Examples

ISO UTC

2026-07-01T00:00:00Z
include_sub_users
boolean

Aggregate the selected user’s data with all of their sub-users. Superusers can apply this to any selected user; resellers can apply it to their own account. Ignored for regular users. Use true or false. Defaults to false.

Examples

Include sub-users

true
limit
integer

Maximum records returned on this page.

offset
integer

Zero-based number of matching records to skip.

package_id
string format: uuid

Restrict results to one purchased package.

Examples
ExamplePackage
550e8400-e29b-41d4-a716-446655440002
start
string

Inclusive start of the reporting window. Defaults to a recent window. Accepts ISO 8601 datetime strings with or without a timezone offset (including Z and fractional seconds), YYYY-MM-DD HH:MM:SS, DD-MM-YYYY HH:MM:SS, YYYY-MM-DD, DD-MM-YYYY, or a Unix timestamp in seconds (including fractional seconds, not milliseconds). Datetime strings without an offset and date-only strings use the requested timezone; explicit offsets are converted to that timezone. Date-only values start at midnight. Seconds and fractional seconds are discarded, rounding the reporting boundary down to the minute. Prefer ISO 8601 with an explicit offset for unambiguous timezone handling.

Examples

ISO UTC

2026-07-01T00:00:00Z
timezone
string

IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).

Examples
ExampleUTC
UTC
user_id
string format: uuid

Restrict results to the current account or an accessible sub-user.

Examples
ExampleUser
550e8400-e29b-41d4-a716-446655440001
Accept-Language
string
default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples
de

The operation completed successfully.

Media typeapplication/json
object
count
required
integer
next
required
string format: uri
nullable
previous
required
string format: uri
nullable
timezone
required
string
start
required
string format: date-time
end
required
string format: date-time
results
required
Array<object>
object
data
required
integer
requests
required
integer
timestamp
required
string format: date-time
Examples
ExampleTrafficOverview

Traffic overview

{
"count": 1,
"next": null,
"previous": null,
"timezone": "UTC",
"start": "2026-07-01T00:00:00Z",
"end": "2026-07-02T00:00:00Z",
"results": [
{
"data": 73400320,
"requests": 1240,
"timestamp": "2026-07-01T00:00:00Z"
}
]
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
]
}
Content-Language
string

Language used for human-readable errors.

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}
Content-Language
string

Language used for human-readable errors.

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}
Content-Language
string

Language used for human-readable errors.

The service could not complete the operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
key
additional properties
One of:
string
Examples
ExampleInternalServiceError

Internal service error

{
"non_field_errors": [
"Internal server error."
]
}
Content-Language
string

Language used for human-readable errors.