Skip to content

List data transactions

GET
/analytics/{id}/transactions
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/analytics/example/transactions?end=2026-07-02T00%3A00%3A00Z&start=2026-07-01T00%3A00%3A00Z&timezone=UTC' \
--header 'Authorization: Bearer <token>'

Returns data allocation and consumption transactions visible to the caller. Sender and recipient filters are restricted to the caller’s scope.

id
required
string

Route identifier for this analytics action. Use query parameters to filter transactions.

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.

recipient_id
string format: uuid

Restrict transactions to this recipient account.

sender_id
string format: uuid

Restrict transactions to this sender account.

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
type
integer

Transaction type identifier. Defaults to data transactions.

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
sender_uuid
required
string
nullable
recipient_uuid
required
string
nullable
type
required
integer
amount
required
integer
package_uuid
required
string
nullable
details
required
string
nullable
date
required
string format: date-time
nullable
timestamp
required
string format: date-time
nullable
Examples
ExampleDataTransactions

Data transactions

{
"count": 1,
"next": null,
"previous": null,
"timezone": "UTC",
"start": "2026-07-01T00:00:00Z",
"end": "2026-07-02T00:00:00Z",
"results": [
{
"sender_uuid": "550e8400-e29b-41d4-a716-446655440001",
"recipient_uuid": null,
"type": 1,
"amount": 1073741824,
"package_uuid": "550e8400-e29b-41d4-a716-446655440002",
"details": "Data used by active proxy sessions",
"date": "2026-07-01T00:00:00Z",
"timestamp": "2026-07-01T12:30: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 requested resource does not exist in the current account scope.

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
Exampleexample

Resource not found

{
"detail": "Not found."
}

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."
]
}