UsageHistoryApi
UsageHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkClientUsageHistory() : object
- Operation getNetworkClientUsageHistory
- getNetworkClientUsageHistoryAsync() : PromiseInterface
- Operation getNetworkClientUsageHistoryAsync
- getNetworkClientUsageHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkClientUsageHistoryAsyncWithHttpInfo
- getNetworkClientUsageHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkClientUsageHistoryWithHttpInfo
- getNetworkWirelessUsageHistory() : object
- Operation getNetworkWirelessUsageHistory
- getNetworkWirelessUsageHistoryAsync() : PromiseInterface
- Operation getNetworkWirelessUsageHistoryAsync
- getNetworkWirelessUsageHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessUsageHistoryAsyncWithHttpInfo
- getNetworkWirelessUsageHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessUsageHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkClientUsageHistoryRequest() : Request
- Create request for operation 'getNetworkClientUsageHistory'
- getNetworkWirelessUsageHistoryRequest() : Request
- Create request for operation 'getNetworkWirelessUsageHistory'
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 —getNetworkClientUsageHistory()
Operation getNetworkClientUsageHistory
public
getNetworkClientUsageHistory(string $network_id, string $client_id) : object
Return the client's daily usage history
Parameters
- $network_id : string
-
network_id (required)
- $client_id : string
-
client_id (required)
Tags
Return values
object —getNetworkClientUsageHistoryAsync()
Operation getNetworkClientUsageHistoryAsync
public
getNetworkClientUsageHistoryAsync(string $network_id, string $client_id) : PromiseInterface
Return the client's daily usage history
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkClientUsageHistoryAsyncWithHttpInfo()
Operation getNetworkClientUsageHistoryAsyncWithHttpInfo
public
getNetworkClientUsageHistoryAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface
Return the client's daily usage history
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkClientUsageHistoryWithHttpInfo()
Operation getNetworkClientUsageHistoryWithHttpInfo
public
getNetworkClientUsageHistoryWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>
Return the client's daily usage history
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkWirelessUsageHistory()
Operation getNetworkWirelessUsageHistory
public
getNetworkWirelessUsageHistory(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 AP usage 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: 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 AP usage over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. Requires :band. (optional)
- $ap_tag : string = null
-
Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (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 —getNetworkWirelessUsageHistoryAsync()
Operation getNetworkWirelessUsageHistoryAsync
public
getNetworkWirelessUsageHistoryAsync(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 AP usage 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: 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 AP usage over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. Requires :band. (optional)
- $ap_tag : string = null
-
Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (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 —getNetworkWirelessUsageHistoryAsyncWithHttpInfo()
Operation getNetworkWirelessUsageHistoryAsyncWithHttpInfo
public
getNetworkWirelessUsageHistoryAsyncWithHttpInfo(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 AP usage 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: 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 AP usage over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. Requires :band. (optional)
- $ap_tag : string = null
-
Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (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 —getNetworkWirelessUsageHistoryWithHttpInfo()
Operation getNetworkWirelessUsageHistoryWithHttpInfo
public
getNetworkWirelessUsageHistoryWithHttpInfo(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 AP usage 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: 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 AP usage over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. Requires :band. (optional)
- $ap_tag : string = null
-
Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (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
getNetworkClientUsageHistoryRequest()
Create request for operation 'getNetworkClientUsageHistory'
protected
getNetworkClientUsageHistoryRequest(string $network_id, string $client_id) : Request
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
Tags
Return values
Request —getNetworkWirelessUsageHistoryRequest()
Create request for operation 'getNetworkWirelessUsageHistory'
protected
getNetworkWirelessUsageHistoryRequest(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 AP usage over time inner joined by the queried client's connection history. (optional)
- $device_serial : string = null
-
Filter results by device. Requires :band. (optional)
- $ap_tag : string = null
-
Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)