Documentation

__construct()


    public
                __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null

Return values

mixed —

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getDeviceWirelessLatencyStats()

Operation getDeviceWirelessLatencyStats


    public
                getDeviceWirelessLatencyStats(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for a given AP on this network

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getDeviceWirelessLatencyStatsAsync()

Operation getDeviceWirelessLatencyStatsAsync


    public
                getDeviceWirelessLatencyStatsAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessLatencyStatsAsyncWithHttpInfo()

Operation getDeviceWirelessLatencyStatsAsyncWithHttpInfo


    public
                getDeviceWirelessLatencyStatsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessLatencyStatsWithHttpInfo()

Operation getDeviceWirelessLatencyStatsWithHttpInfo


    public
                getDeviceWirelessLatencyStatsWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientLatencyStats()

Operation getNetworkWirelessClientLatencyStats


    public
                getNetworkWirelessClientLatencyStats(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for a given client on this network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessClientLatencyStatsAsync()

Operation getNetworkWirelessClientLatencyStatsAsync


    public
                getNetworkWirelessClientLatencyStatsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientsLatencyStats()

Operation getNetworkWirelessClientsLatencyStats


    public
                getNetworkWirelessClientsLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessClientsLatencyStatsAsync()

Operation getNetworkWirelessClientsLatencyStatsAsync


    public
                getNetworkWirelessClientsLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessDevicesLatencyStats()

Operation getNetworkWirelessDevicesLatencyStats


    public
                getNetworkWirelessDevicesLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessDevicesLatencyStatsAsync()

Operation getNetworkWirelessDevicesLatencyStatsAsync


    public
                getNetworkWirelessDevicesLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesLatencyStatsWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessLatencyStats()

Operation getNetworkWirelessLatencyStats


    public
                getNetworkWirelessLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

object —

getNetworkWirelessLatencyStatsAsync()

Operation getNetworkWirelessLatencyStatsAsync


    public
                getNetworkWirelessLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyStatsWithHttpInfo()

Operation getNetworkWirelessLatencyStatsWithHttpInfo


    public
                getNetworkWirelessLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                createHttpClientOption() : array<string|int, mixed>

Tags

Return values

array<string|int, mixed> —

of http client options

getDeviceWirelessLatencyStatsRequest()

Create request for operation 'getDeviceWirelessLatencyStats'


    protected
                getDeviceWirelessLatencyStatsRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

getNetworkWirelessClientLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientLatencyStats'


    protected
                getNetworkWirelessClientLatencyStatsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

getNetworkWirelessClientsLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientsLatencyStats'


    protected
                getNetworkWirelessClientsLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

getNetworkWirelessDevicesLatencyStatsRequest()

Create request for operation 'getNetworkWirelessDevicesLatencyStats'


    protected
                getNetworkWirelessDevicesLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

getNetworkWirelessLatencyStatsRequest()

Create request for operation 'getNetworkWirelessLatencyStats'


    protected
                getNetworkWirelessLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string. (optional)

Tags

Return values

Request —

LatencyStatsApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

getConfig()

Return values

getDeviceWirelessLatencyStats()

Parameters

Tags

Return values

getDeviceWirelessLatencyStatsAsync()

Parameters

Tags

Return values

getDeviceWirelessLatencyStatsAsyncWithHttpInfo()

Parameters

Tags

Return values

getDeviceWirelessLatencyStatsWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessClientLatencyStats()

Parameters

Tags

Return values

getNetworkWirelessClientLatencyStatsAsync()

Parameters

Tags

Return values

getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessClientLatencyStatsWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessClientsLatencyStats()

Parameters

Tags

Return values

getNetworkWirelessClientsLatencyStatsAsync()

Parameters

Tags

Return values

getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessClientsLatencyStatsWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessDevicesLatencyStats()

Parameters

Tags

Return values

getNetworkWirelessDevicesLatencyStatsAsync()

Parameters

Tags

Return values

getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessDevicesLatencyStatsWithHttpInfo()

Parameters

Tags

Return values

getNetworkWirelessLatencyStats()

Parameters

Tags