ChannelUtilizationHistoryApi
ChannelUtilizationHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkWirelessChannelUtilizationHistory() : object
- Operation getNetworkWirelessChannelUtilizationHistory
- getNetworkWirelessChannelUtilizationHistoryAsync() : PromiseInterface
- Operation getNetworkWirelessChannelUtilizationHistoryAsync
- getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo
- getNetworkWirelessChannelUtilizationHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessChannelUtilizationHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkWirelessChannelUtilizationHistoryRequest() : Request
- Create request for operation 'getNetworkWirelessChannelUtilizationHistory'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__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 —getNetworkWirelessChannelUtilizationHistory()
Operation getNetworkWirelessChannelUtilizationHistory
public
getNetworkWirelessChannelUtilizationHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : object
Return AP channel utilization over time for a device or network client
Parameters
- $network_id : string
-
network_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
- $ap_tag : string = null
-
Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
Tags
Return values
object —getNetworkWirelessChannelUtilizationHistoryAsync()
Operation getNetworkWirelessChannelUtilizationHistoryAsync
public
getNetworkWirelessChannelUtilizationHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : PromiseInterface
Return AP channel utilization over time for a device or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
- $ap_tag : string = null
-
Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo()
Operation getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo
public
getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : PromiseInterface
Return AP channel utilization over time for a device or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
- $ap_tag : string = null
-
Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessChannelUtilizationHistoryWithHttpInfo()
Operation getNetworkWirelessChannelUtilizationHistoryWithHttpInfo
public
getNetworkWirelessChannelUtilizationHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : array<string|int, mixed>
Return AP channel utilization over time for a device or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
- $ap_tag : string = null
-
Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (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
getNetworkWirelessChannelUtilizationHistoryRequest()
Create request for operation 'getNetworkWirelessChannelUtilizationHistory'
protected
getNetworkWirelessChannelUtilizationHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 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 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
- $ap_tag : string = null
-
Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)