ClientCountHistoryApi
ClientCountHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkWirelessClientCountHistory() : object
- Operation getNetworkWirelessClientCountHistory
- getNetworkWirelessClientCountHistoryAsync() : PromiseInterface
- Operation getNetworkWirelessClientCountHistoryAsync
- getNetworkWirelessClientCountHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessClientCountHistoryAsyncWithHttpInfo
- getNetworkWirelessClientCountHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessClientCountHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkWirelessClientCountHistoryRequest() : Request
- Create request for operation 'getNetworkWirelessClientCountHistory'
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 —getNetworkWirelessClientCountHistory()
Operation getNetworkWirelessClientCountHistory
public
getNetworkWirelessClientCountHistory(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 ][, int $ssid = null ]) : object
Return wireless client counts over time for a network, 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: 300, 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 client counts over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
Tags
Return values
object —getNetworkWirelessClientCountHistoryAsync()
Operation getNetworkWirelessClientCountHistoryAsync
public
getNetworkWirelessClientCountHistoryAsync(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 ][, int $ssid = null ]) : PromiseInterface
Return wireless client counts over time for a network, 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: 300, 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 client counts over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientCountHistoryAsyncWithHttpInfo()
Operation getNetworkWirelessClientCountHistoryAsyncWithHttpInfo
public
getNetworkWirelessClientCountHistoryAsyncWithHttpInfo(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 ][, int $ssid = null ]) : PromiseInterface
Return wireless client counts over time for a network, 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: 300, 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 client counts over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientCountHistoryWithHttpInfo()
Operation getNetworkWirelessClientCountHistoryWithHttpInfo
public
getNetworkWirelessClientCountHistoryWithHttpInfo(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 ][, int $ssid = null ]) : array<string|int, mixed>
Return wireless client counts over time for a network, 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: 300, 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 client counts over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (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
getNetworkWirelessClientCountHistoryRequest()
Create request for operation 'getNetworkWirelessClientCountHistory'
protected
getNetworkWirelessClientCountHistoryRequest(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 ][, int $ssid = 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: 300, 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 client counts over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)