OverviewApi
OverviewApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getDeviceCameraAnalyticsOverview() : object
- Operation getDeviceCameraAnalyticsOverview
- getDeviceCameraAnalyticsOverviewAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsOverviewAsync
- getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo
- getDeviceCameraAnalyticsOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsOverviewWithHttpInfo
- getNetworkClientsOverview() : object
- Operation getNetworkClientsOverview
- getNetworkClientsOverviewAsync() : PromiseInterface
- Operation getNetworkClientsOverviewAsync
- getNetworkClientsOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkClientsOverviewAsyncWithHttpInfo
- getNetworkClientsOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkClientsOverviewWithHttpInfo
- getOrganizationApiRequestsOverview() : object
- Operation getOrganizationApiRequestsOverview
- getOrganizationApiRequestsOverviewAsync() : PromiseInterface
- Operation getOrganizationApiRequestsOverviewAsync
- getOrganizationApiRequestsOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApiRequestsOverviewAsyncWithHttpInfo
- getOrganizationApiRequestsOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApiRequestsOverviewWithHttpInfo
- getOrganizationLicensesOverview() : object
- Operation getOrganizationLicensesOverview
- getOrganizationLicensesOverviewAsync() : PromiseInterface
- Operation getOrganizationLicensesOverviewAsync
- getOrganizationLicensesOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationLicensesOverviewAsyncWithHttpInfo
- getOrganizationLicensesOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationLicensesOverviewWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getDeviceCameraAnalyticsOverviewRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsOverview'
- getNetworkClientsOverviewRequest() : Request
- Create request for operation 'getNetworkClientsOverview'
- getOrganizationApiRequestsOverviewRequest() : Request
- Create request for operation 'getOrganizationApiRequestsOverview'
- getOrganizationLicensesOverviewRequest() : Request
- Create request for operation 'getOrganizationLicensesOverview'
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 —getDeviceCameraAnalyticsOverview()
Operation getDeviceCameraAnalyticsOverview
public
getDeviceCameraAnalyticsOverview(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : object
Returns an overview of aggregate analytics data for a timespan
Parameters
- $serial : string
-
serial (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 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. The default is 1 hour. (optional)
- $object_type : string = null
-
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)
Tags
Return values
object —getDeviceCameraAnalyticsOverviewAsync()
Operation getDeviceCameraAnalyticsOverviewAsync
public
getDeviceCameraAnalyticsOverviewAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface
Returns an overview of aggregate analytics data for a timespan
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 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. The default is 1 hour. (optional)
- $object_type : string = null
-
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo()
Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo
public
getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface
Returns an overview of aggregate analytics data for a timespan
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 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. The default is 1 hour. (optional)
- $object_type : string = null
-
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsOverviewWithHttpInfo()
Operation getDeviceCameraAnalyticsOverviewWithHttpInfo
public
getDeviceCameraAnalyticsOverviewWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : array<string|int, mixed>
Returns an overview of aggregate analytics data for a timespan
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 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. The default is 1 hour. (optional)
- $object_type : string = null
-
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkClientsOverview()
Operation getNetworkClientsOverview
public
getNetworkClientsOverview(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object
Return overview statistics for network clients
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)
Tags
Return values
object —getNetworkClientsOverviewAsync()
Operation getNetworkClientsOverviewAsync
public
getNetworkClientsOverviewAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface
Return overview statistics for network clients
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)
Tags
Return values
PromiseInterface —getNetworkClientsOverviewAsyncWithHttpInfo()
Operation getNetworkClientsOverviewAsyncWithHttpInfo
public
getNetworkClientsOverviewAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface
Return overview statistics for network clients
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)
Tags
Return values
PromiseInterface —getNetworkClientsOverviewWithHttpInfo()
Operation getNetworkClientsOverviewWithHttpInfo
public
getNetworkClientsOverviewWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>
Return overview statistics for network clients
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationApiRequestsOverview()
Operation getOrganizationApiRequestsOverview
public
getOrganizationApiRequestsOverview(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object
Return an aggregated overview of API requests data
Parameters
- $organization_id : string
-
organization_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 31 days. (optional)
Tags
Return values
object —getOrganizationApiRequestsOverviewAsync()
Operation getOrganizationApiRequestsOverviewAsync
public
getOrganizationApiRequestsOverviewAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return an aggregated overview of API requests data
Parameters
- $organization_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 31 days. (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsOverviewAsyncWithHttpInfo()
Operation getOrganizationApiRequestsOverviewAsyncWithHttpInfo
public
getOrganizationApiRequestsOverviewAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return an aggregated overview of API requests data
Parameters
- $organization_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 31 days. (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsOverviewWithHttpInfo()
Operation getOrganizationApiRequestsOverviewWithHttpInfo
public
getOrganizationApiRequestsOverviewWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>
Return an aggregated overview of API requests data
Parameters
- $organization_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 31 days. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationLicensesOverview()
Operation getOrganizationLicensesOverview
public
getOrganizationLicensesOverview(string $organization_id) : object
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationLicensesOverviewAsync()
Operation getOrganizationLicensesOverviewAsync
public
getOrganizationLicensesOverviewAsync(string $organization_id) : PromiseInterface
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicensesOverviewAsyncWithHttpInfo()
Operation getOrganizationLicensesOverviewAsyncWithHttpInfo
public
getOrganizationLicensesOverviewAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationLicensesOverviewWithHttpInfo()
Operation getOrganizationLicensesOverviewWithHttpInfo
public
getOrganizationLicensesOverviewWithHttpInfo(string $organization_id) : array<string|int, mixed>
Return an overview of the license state for an organization
Parameters
- $organization_id : string
-
(required)
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
getDeviceCameraAnalyticsOverviewRequest()
Create request for operation 'getDeviceCameraAnalyticsOverview'
protected
getDeviceCameraAnalyticsOverviewRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : Request
Parameters
- $serial : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 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. The default is 1 hour. (optional)
- $object_type : string = null
-
[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)
Tags
Return values
Request —getNetworkClientsOverviewRequest()
Create request for operation 'getNetworkClientsOverview'
protected
getNetworkClientsOverviewRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = 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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)
Tags
Return values
Request —getOrganizationApiRequestsOverviewRequest()
Create request for operation 'getOrganizationApiRequestsOverview'
protected
getOrganizationApiRequestsOverviewRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request
Parameters
- $organization_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 31 days. (optional)
Tags
Return values
Request —getOrganizationLicensesOverviewRequest()
Create request for operation 'getOrganizationLicensesOverview'
protected
getOrganizationLicensesOverviewRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)