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-02T00%3A00%3A00Z&package_id=550e8400-e29b-41d4-a716-446655440002&start=2026-07-01T00%3A00%3A00Z&timezone=UTC&user_id=550e8400-e29b-41d4-a716-446655440001' \
--header 'Authorization: Bearer <token>'

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

end
string format: date-time

Exclusive end of the reporting window.

Examples
ExampleEndTime

End time

2026-07-02T00:00:00Z
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 format: date-time

Inclusive start of the reporting window. Defaults to a recent window.

Examples
ExampleStartTime

Start time

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

IANA timezone used for bucket boundaries. Defaults to UTC.

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

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>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

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>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

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>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}

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>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleInternalServiceError

Internal service error

{
"non_field_errors": [
"Internal server error."
]
}