Analytics

SDK Reference · Resource

Analytics

Inspect proxy traffic, connections, domains, errors, and data transactions.

getTransactions()getConnections()listDomains()listFeed()listLogs()getOverall()

method

getTransactions()

List data transactions

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

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.getTransactions(options: AnalyticsGetTransactionsOptions): Promise<AnalyticsGetTransactionsResponse>

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
id	string	Required	Route identifier for this analytics action. Use query parameters to filter transactions.
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
recipientId	string	Optional	Restrict transactions to this recipient account.
senderId	string	Optional	Restrict transactions to this sender account.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
type	number	Optional	Transaction type identifier. Defaults to data transactions.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.analytics.getTransactions({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

TransactionsResponse

The operation completed successfully.

typeTransactionsResponse7fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Required

—

previous

string

Required

—

timezone

string

Required

—

start

string

Required

—

end

string

Required

—

results

TransactionRecord[]

Required

—

typeTransactionRecord8fields

FieldTypeRequirementDescription

sender_uuid

string

Required

—

recipient_uuid

string

Required

—

type

number

Required

—

amount

number

Required

—

package_uuid

string

Required

—

details

string

Required

—

date

string

Required

—

timestamp

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.getTransactionsWithResponse(options): Promise<ApiResponse<AnalyticsGetTransactionsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.get_transactions(id: str, *, end: datetime.datetime | float | int | str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, recipient_id: UUID | Unset=UNSET, sender_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, type_: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> TransactionsResponse

Asyncawait async_client.analytics.get_transactions(id: str, *, end: datetime.datetime | float | int | str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, recipient_id: UUID | Unset=UNSET, sender_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, type_: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> TransactionsResponse

Parameters

Name	Type	Requirement	Description
end	str | int | float	Optional	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.
id	str	Required	Route identifier for this analytics action. Use query parameters to filter transactions.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
recipient_id	str	Optional	Restrict transactions to this recipient account.
sender_id	str	Optional	Restrict transactions to this sender account.
start	str | int | float	Optional	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.
timezone	str	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
type	int	Optional	Transaction type identifier. Defaults to data transactions.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.analytics.get_transactions(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.analytics.get_transactions(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

TransactionsResponse

The operation completed successfully.

classTransactionsResponse7fields

FieldTypeRequirementDescription

count

int

Required

—

next_

None | str

Required

—

previous

None | str

Required

—

timezone

str

Required

—

start

datetime.datetime

Required

—

end

datetime.datetime

Required

—

results

list[TransactionRecord]

Required

—

classTransactionRecord8fields

FieldTypeRequirementDescription

sender_uuid

None | str

Required

—

recipient_uuid

None | str

Required

—

type_

int

Required

—

amount

int

Required

—

package_uuid

None | str

Required

—

details

None | str

Required

—

date

datetime.datetime | None

Required

—

timestamp

datetime.datetime | None

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.get_transactions_with_response(id: str, *, end: datetime.datetime | float | int | str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, recipient_id: UUID | Unset=UNSET, sender_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, type_: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[TransactionsResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->getTransactions($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0])

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
id	string	Required	Route identifier for this analytics action. Use query parameters to filter transactions.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
recipientId	string	Optional	Restrict transactions to this recipient account.
senderId	string	Optional	Restrict transactions to this sender account.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
type	int	Optional	Transaction type identifier. Defaults to data transactions.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->getTransactions(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

TransactionsResponse

The operation completed successfully.

classTransactionsResponse7fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

|

previous

string

Required

|

timezone

string

Required

|

start

DateTime

Required

|

end

DateTime

Required

|

results

[TransactionRecord[]](TransactionRecord.md)

Required

|

classTransactionRecord8fields

FieldTypeRequirementDescription

senderUuid

string

Required

|

recipientUuid

string

Required

|

type

int

Required

|

amount

int

Required

|

packageUuid

string

Required

|

details

string

Required

|

date

DateTime

Required

|

timestamp

DateTime

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->getTransactionsWithResponse($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->getTransactionsWithHttpInfo($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->getTransactionsAsync($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->getTransactionsAsyncWithHttpInfo($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->getTransactionsRequest($id, $end = null, $limit = null, $offset = null, $recipientId = null, $senderId = null, $start = null, $timezone = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['getTransactions'][0])

  Builds the PSR-7 request without sending it.

method

getConnections()

List active proxy connections

Returns a paginated snapshot of active connections for the selected user and package scope.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.getConnections(options: AnalyticsGetConnectionsOptions = {}): Promise<AnalyticsGetConnectionsResponse>

Parameters

Name	Type	Requirement	Description
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.analytics.getConnections();

Returns

ConnectionsResponse

The operation completed successfully.

typeConnectionsResponse4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Required

—

previous

string

Required

—

results

ConnectionRecord[]

Required

—

typeConnectionRecord4fields

FieldTypeRequirementDescription

user_id

string

Required

—

package_id

string

Required

—

connections

number

Required

—

server_ip

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.getConnectionsWithResponse(options): Promise<ApiResponse<AnalyticsGetConnectionsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.get_connections(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ConnectionsResponse

Asyncawait async_client.analytics.get_connections(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ConnectionsResponse

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
package_id	str	Optional	Restrict results to one purchased package.
user_id	str	Optional	Restrict results to the current account or an accessible sub-user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.analytics.get_connections()

Async example

result = await async_client.analytics.get_connections()

Returns

ConnectionsResponse

The operation completed successfully.

classConnectionsResponse4fields

FieldTypeRequirementDescription

count

int

Required

—

next_

None | str

Required

—

previous

None | str

Required

—

results

list[ConnectionRecord]

Required

—

classConnectionRecord4fields

FieldTypeRequirementDescription

user_id

UUID

Required

—

package_id

UUID

Required

—

connections

int

Required

—

server_ip

str

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.get_connections_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[ConnectionsResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->getConnections($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0])

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->getConnections();

Returns

ConnectionsResponse

The operation completed successfully.

classConnectionsResponse4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

|

previous

string

Required

|

results

[ConnectionRecord[]](ConnectionRecord.md)

Required

|

classConnectionRecord4fields

FieldTypeRequirementDescription

userId

string

Required

|

packageId

string

Required

|

connections

int

Required

|

serverIp

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->getConnectionsWithResponse($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->getConnectionsWithHttpInfo($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->getConnectionsAsync($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->getConnectionsAsyncWithHttpInfo($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->getConnectionsRequest($limit = null, $offset = null, $packageId = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getConnections'][0])

  Builds the PSR-7 request without sending it.

method

listDomains()

List top destination domains

Aggregates request count and transferred bytes by destination hostname for the selected reporting window and account scope.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.listDomains(options: AnalyticsListDomainsOptions = {}): Promise<AnalyticsListDomainsResponse>

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
hostname	string	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
includeSubUsers	boolean	Optional	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.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
ordering	string	Optional	Sort domains by transferred data or request count.
packageId	string	Optional	Restrict results to one purchased package.
search	string	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.analytics.listDomains();

Returns

DomainsResponse

The operation completed successfully.

typeDomainsResponse6fields

FieldTypeRequirementDescription

next

string

Required

—

previous

string

Required

—

timezone

string

Required

—

start

string

Required

—

end

string

Required

—

results

DomainRecord[]

Required

—

typeDomainRecord3fields

FieldTypeRequirementDescription

hostname

string

Required

—

requests

number

Required

—

data

number

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.listDomainsWithResponse(options): Promise<ApiResponse<AnalyticsListDomainsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.list_domains(*, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, include_sub_users: bool | Unset=False, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: AnalyticsDomainsRetrieveOrdering | Unset=AnalyticsDomainsRetrieveOrdering.VALUE_0, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> DomainsResponse

Asyncawait async_client.analytics.list_domains(*, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, include_sub_users: bool | Unset=False, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: AnalyticsDomainsRetrieveOrdering | Unset=AnalyticsDomainsRetrieveOrdering.VALUE_0, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> DomainsResponse

Parameters

Name	Type	Requirement	Description
end	str | int | float	Optional	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.
hostname	str	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
include_sub_users	bool	Optional	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.
ledger_id	str	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
ordering	str	Optional	Sort domains by transferred data or request count.
package_id	str	Optional	Restrict results to one purchased package.
search	str	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	str | int | float	Optional	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.
timezone	str	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
user_id	str	Optional	Restrict results to the current account or an accessible sub-user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.analytics.list_domains()

Async example

result = await async_client.analytics.list_domains()

Returns

DomainsResponse

The operation completed successfully.

classDomainsResponse6fields

FieldTypeRequirementDescription

next_

None | str

Required

—

previous

None | str

Required

—

timezone

str

Required

—

start

datetime.datetime

Required

—

end

datetime.datetime

Required

—

results

list[DomainRecord]

Required

—

classDomainRecord3fields

FieldTypeRequirementDescription

hostname

str

Required

—

requests

int

Required

—

data

int

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.list_domains_with_response(*, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, include_sub_users: bool | Unset=False, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: AnalyticsDomainsRetrieveOrdering | Unset=AnalyticsDomainsRetrieveOrdering.VALUE_0, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[DomainsResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->listDomains($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0])

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
hostname	string	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
includeSubUsers	bool	Optional	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.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
ordering	string	Optional	Sort domains by transferred data or request count.
packageId	string	Optional	Restrict results to one purchased package.
search	string	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->listDomains();

Returns

DomainsResponse

The operation completed successfully.

classDomainsResponse6fields

FieldTypeRequirementDescription

next

string

Required

|

previous

string

Required

|

timezone

string

Required

|

start

DateTime

Required

|

end

DateTime

Required

|

results

[DomainRecord[]](DomainRecord.md)

Required

|

classDomainRecord3fields

FieldTypeRequirementDescription

hostname

string

Required

|

requests

int

Required

|

data

int

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->listDomainsWithResponse($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->listDomainsWithHttpInfo($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->listDomainsAsync($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->listDomainsAsyncWithHttpInfo($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->listDomainsRequest($end = null, $hostname = null, $includeSubUsers = false, $ledgerId = null, $limit = null, $offset = null, $ordering = '-data', $packageId = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listDomains'][0])

  Builds the PSR-7 request without sending it.

method

listFeed()

List proxy request activity

Returns recent proxy requests with traffic, endpoint, location, protocol, package, and sticky-session details.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.listFeed(options: AnalyticsListFeedOptions = {}): Promise<AnalyticsListFeedResponse>

Parameters

Name	Type	Requirement	Description
city	string	Optional	Normalized city targeting code. country and region are required.
country	string	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	string	Optional	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.
hostname	string	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
protocol	string	Optional	Proxy protocol: http or socks5.
region	string	Optional	Normalized region targeting code. country is required.
search	string	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.analytics.listFeed();

Returns

FeedResponse

The operation completed successfully.

typeFeedResponse7fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Required

—

previous

string

Required

—

timezone

string

Required

—

start

string

Required

—

end

string

Required

—

results

FeedRecord[]

Required

—

typeFeedRecord20fields

FieldTypeRequirementDescription

id

string

Required

Exact decimal UInt64 identifier, normalized from the API's JSON number.

established_connections

number

Required

—

reseller_id

string

Required

—

user_id

string

Required

—

package_id

string

Required

—

ledger_id

string

Required

—

username

string

Required

—

user_ip

string

Required

—

server_ip

string

Required

—

data

number

Required

—

hostname

string

Required

—

protocol

string

Required

—

method

string

Required

—

pool

string

Required

—

is_session

boolean

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

timestamp

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.listFeedWithResponse(options): Promise<ApiResponse<AnalyticsListFeedResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.list_feed(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsFeedRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> FeedResponse

Asyncawait async_client.analytics.list_feed(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsFeedRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> FeedResponse

Parameters

Name	Type	Requirement	Description
city	str	Optional	Normalized city targeting code. country and region are required.
country	str	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	str | int | float	Optional	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.
hostname	str	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
ledger_id	str	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
package_id	str	Optional	Restrict results to one purchased package.
protocol	str	Optional	Proxy protocol: http or socks5.
region	str	Optional	Normalized region targeting code. country is required.
search	str	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	str | int | float	Optional	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.
timezone	str	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
user_id	str	Optional	Restrict results to the current account or an accessible sub-user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.analytics.list_feed()

Async example

result = await async_client.analytics.list_feed()

Returns

FeedResponse

The operation completed successfully.

classFeedResponse7fields

FieldTypeRequirementDescription

count

int

Required

—

next_

None | str

Required

—

previous

None | str

Required

—

timezone

str

Required

—

start

datetime.datetime

Required

—

end

datetime.datetime

Required

—

results

list[FeedRecord]

Required

—

classFeedRecord20fields

FieldTypeRequirementDescription

id

int

Required

—

established_connections

int

Required

—

reseller_id

str

Required

—

user_id

str

Required

—

package_id

str

Required

—

ledger_id

str

Required

—

username

str

Required

—

user_ip

str

Required

—

server_ip

str

Required

—

data

int

Required

—

hostname

str

Required

—

protocol

str

Required

—

method

str

Required

—

pool

str

Required

—

is_session

bool

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

timestamp

datetime.datetime | None

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.list_feed_with_response(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsFeedRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, search: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[FeedResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->listFeed($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0])

Parameters

Name	Type	Requirement	Description
city	string	Optional	Normalized city targeting code. country and region are required.
country	string	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	string	Optional	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.
hostname	string	Optional	Comma-separated domains, IPv4/IPv6 addresses or HTTP(S) URLs to include. Surrounding whitespace is ignored. URLs and host:port values are normalized to their hostname; schemes, ports, paths and IPv6 brackets are removed. Use brackets around IPv6 addresses when specifying a port.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
protocol	string	Optional	Proxy protocol: http or socks5.
region	string	Optional	Normalized region targeting code. country is required.
search	string	Optional	Case-insensitive partial match against the listed field: `hostname`.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->listFeed();

Returns

FeedResponse

The operation completed successfully.

classFeedResponse7fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

|

previous

string

Required

|

timezone

string

Required

|

start

DateTime

Required

|

end

DateTime

Required

|

results

[FeedRecord[]](FeedRecord.md)

Required

|

classFeedRecord20fields

FieldTypeRequirementDescription

id

string

Required

Exact decimal UInt64 identifier, normalized from the API JSON number. |

establishedConnections

int

Required

|

resellerId

string

Required

|

userId

string

Required

|

packageId

string

Required

|

ledgerId

string

Required

|

username

string

Required

|

userIp

string

Required

|

serverIp

string

Required

|

data

int

Required

|

hostname

string

Required

|

protocol

string

Required

|

method

string

Required

|

pool

string

Required

|

isSession

bool

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

timestamp

DateTime

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->listFeedWithResponse($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->listFeedWithHttpInfo($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->listFeedAsync($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->listFeedAsyncWithHttpInfo($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->listFeedRequest($city = null, $country = null, $end = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $search = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listFeed'][0])

  Builds the PSR-7 request without sending it.

method

listLogs()

List proxy error logs

Returns request-level proxy errors with server, client, targeting, package, and error-code context.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.listLogs(options: AnalyticsListLogsOptions = {}): Promise<AnalyticsListLogsResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
city	string	Optional	Normalized city targeting code. country and region are required.
country	string	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	string	Optional	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.
errorCode	number	Optional	Restrict results to one non-negative proxy error code.
hostname	string	Optional	Compatibility parameter; ignored by the server.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
protocol	string	Optional	Proxy protocol: http or socks5.
region	string	Optional	Normalized region targeting code. country is required.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.

Example

const result = await client.analytics.listLogs();

Returns

LogsResponse

The operation completed successfully.

typeLogsResponse7fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Required

—

previous

string

Required

—

timezone

string

Required

—

start

string

Required

—

end

string

Required

—

results

LogRecord[]

Required

—

typeLogRecord22fields

FieldTypeRequirementDescription

id

number

Required

—

server_ip

string

Required

—

user_ip

string

Required

—

protocol

string

Required

—

method

string

Required

—

user_id

string

Required

—

reseller_id

string

Required

—

username

string

Required

—

hostname

string

Required

—

status_code

number

Required

—

error_code

number

Required

—

error_message

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

level

string

Required

—

is_session

boolean

Required

—

timestamp

string

Required

—

package_id

string

Optional

—

package_alias

string

Optional

—

ledger_id

string

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.listLogsWithResponse(options): Promise<ApiResponse<AnalyticsListLogsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.list_logs(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, error_code: int | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsLogsRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> LogsResponse

Asyncawait async_client.analytics.list_logs(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, error_code: int | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsLogsRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> LogsResponse

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
city	str	Optional	Normalized city targeting code. country and region are required.
country	str	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	str | int | float	Optional	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.
error_code	int	Optional	Restrict results to one non-negative proxy error code.
hostname	str	Optional	Compatibility parameter; ignored by the server.
ledger_id	str	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
package_id	str	Optional	Restrict results to one purchased package.
protocol	str	Optional	Proxy protocol: http or socks5.
region	str	Optional	Normalized region targeting code. country is required.
start	str | int | float	Optional	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.
timezone	str	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
user_id	str	Optional	Restrict results to the current account or an accessible sub-user.

Example

result = client.analytics.list_logs()

Async example

result = await async_client.analytics.list_logs()

Returns

LogsResponse

The operation completed successfully.

classLogsResponse7fields

FieldTypeRequirementDescription

count

int

Required

—

next_

None | str

Required

—

previous

None | str

Required

—

timezone

str

Required

—

start

datetime.datetime

Required

—

end

datetime.datetime

Required

—

results

list[LogRecord]

Required

—

classLogRecord22fields

FieldTypeRequirementDescription

id

int

Required

—

server_ip

None | str

Required

—

user_ip

None | str

Required

—

protocol

str

Required

—

method

str

Required

—

user_id

str

Required

—

reseller_id

str

Required

—

username

str

Required

—

hostname

str

Required

—

status_code

int

Required

—

error_code

int

Required

—

error_message

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

level

str

Required

—

is_session

bool

Required

—

timestamp

datetime.datetime

Required

—

package_id

str

Optional

—

package_alias

str

Optional

—

ledger_id

str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.list_logs_with_response(*, city: str | Unset=UNSET, country: str | Unset=UNSET, end: datetime.datetime | float | int | str | Unset=UNSET, error_code: int | Unset=UNSET, hostname: str | Unset=UNSET, ledger_id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, protocol: AnalyticsLogsRetrieveProtocol | Unset=UNSET, region: str | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[LogsResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->listLogs($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0])

Parameters

Name	Type	Requirement	Description
city	string	Optional	Normalized city targeting code. country and region are required.
country	string	Optional	Lowercase ISO 3166-1 alpha-2 country code.
end	string	Optional	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.
errorCode	int	Optional	Restrict results to one non-negative proxy error code.
ledgerId	string	Optional	Restrict results to one data ledger when supported.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
protocol	string	Optional	Proxy protocol: http or socks5.
region	string	Optional	Normalized region targeting code. country is required.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->listLogs();

Returns

LogsResponse

The operation completed successfully.

classLogsResponse7fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

|

previous

string

Required

|

timezone

string

Required

|

start

DateTime

Required

|

end

DateTime

Required

|

results

[LogRecord[]](LogRecord.md)

Required

|

classLogRecord22fields

FieldTypeRequirementDescription

id

int

Required

|

serverIp

string

Required

|

userIp

string

Required

|

protocol

string

Required

|

method

string

Required

|

userId

string

Required

|

resellerId

string

Required

|

username

string

Required

|

hostname

string

Required

|

statusCode

int

Required

|

errorCode

int

Required

|

errorMessage

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

level

string

Required

|

isSession

bool

Required

|

timestamp

DateTime

Required

|

packageId

string

Required

| [optional]

packageAlias

string

Required

| [optional]

ledgerId

string

Required

| [optional]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->listLogsWithResponse($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->listLogsWithHttpInfo($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->listLogsAsync($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->listLogsAsyncWithHttpInfo($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->listLogsRequest($city = null, $country = null, $end = null, $errorCode = null, $hostname = null, $ledgerId = null, $limit = null, $offset = null, $packageId = null, $protocol = null, $region = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['listLogs'][0])

  Builds the PSR-7 request without sending it.

method

getOverall()

Get traffic totals over time

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

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.analytics.getOverall(options: AnalyticsGetOverallOptions = {}): Promise<AnalyticsGetOverallResponse>

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
includeSubUsers	boolean	Optional	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.
limit	number	Optional	Maximum records returned on this page.
offset	number	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.analytics.getOverall();

Returns

OverallResponse

The operation completed successfully.

typeOverallResponse7fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Required

—

previous

string

Required

—

timezone

string

Required

—

start

string

Required

—

end

string

Required

—

results

OverallPoint[]

Required

—

typeOverallPoint3fields

FieldTypeRequirementDescription

data

number

Required

—

requests

number

Required

—

timestamp

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "server"ProxyRequest could not complete the operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.getOverallWithResponse(options): Promise<ApiResponse<AnalyticsGetOverallResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.analytics.get_overall(*, end: datetime.datetime | float | int | str | Unset=UNSET, include_sub_users: bool | Unset=False, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> OverallResponse

Asyncawait async_client.analytics.get_overall(*, end: datetime.datetime | float | int | str | Unset=UNSET, include_sub_users: bool | Unset=False, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> OverallResponse

Parameters

Name	Type	Requirement	Description
end	str | int | float	Optional	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.
include_sub_users	bool	Optional	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.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
package_id	str	Optional	Restrict results to one purchased package.
start	str | int | float	Optional	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.
timezone	str	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
user_id	str	Optional	Restrict results to the current account or an accessible sub-user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.analytics.get_overall()

Async example

result = await async_client.analytics.get_overall()

Returns

OverallResponse

The operation completed successfully.

classOverallResponse7fields

FieldTypeRequirementDescription

count

int

Required

—

next_

None | str

Required

—

previous

None | str

Required

—

timezone

str

Required

—

start

datetime.datetime

Required

—

end

datetime.datetime

Required

—

results

list[OverallPoint]

Required

—

classOverallPoint3fields

FieldTypeRequirementDescription

data

int

Required

—

requests

int

Required

—

timestamp

datetime.datetime

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.SERVERProxyRequest could not complete the operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.analytics.get_overall_with_response(*, end: datetime.datetime | float | int | str | Unset=UNSET, include_sub_users: bool | Unset=False, limit: int | Unset=UNSET, offset: int | Unset=UNSET, package_id: UUID | Unset=UNSET, start: datetime.datetime | float | int | str | Unset=UNSET, timezone: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[OverallResponse]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->analytics()->getOverall($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0])

Parameters

Name	Type	Requirement	Description
end	string	Optional	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.
includeSubUsers	bool	Optional	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.
limit	int	Optional	Maximum records returned on this page.
offset	int	Optional	Zero-based number of matching records to skip.
packageId	string	Optional	Restrict results to one purchased package.
start	string	Optional	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.
timezone	string	Optional	IANA timezone used for bucket boundaries and datetime strings without an offset. Missing, empty or unknown names use the deployment timezone (UTC by default).
userId	string	Optional	Restrict results to the current account or an accessible sub-user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->analytics()->getOverall();

Returns

OverallResponse

The operation completed successfully.

classOverallResponse7fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

|

previous

string

Required

|

timezone

string

Required

|

start

DateTime

Required

|

end

DateTime

Required

|

results

[OverallPoint[]](OverallPoint.md)

Required

|

classOverallPoint3fields

FieldTypeRequirementDescription

data

int

Required

|

requests

int

Required

|

timestamp

DateTime

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ServerProxyRequest could not complete the operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->analytics()->getOverallWithResponse($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->analytics()->getOverallWithHttpInfo($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0])

  Returns the OpenAPI Generator response tuple.

• $client->analytics()->getOverallAsync($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0])

  Returns a Guzzle promise for the decoded result.

• $client->analytics()->getOverallAsyncWithHttpInfo($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0])

  Returns a Guzzle promise for the response tuple.

• $client->analytics()->getOverallRequest($end = null, $includeSubUsers = false, $limit = null, $offset = null, $packageId = null, $start = null, $timezone = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['getOverall'][0])

  Builds the PSR-7 request without sending it.