AnalyticsApi
AnalyticsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getDeviceCameraAnalyticsLive() : object
- Operation getDeviceCameraAnalyticsLive
- getDeviceCameraAnalyticsLiveAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsLiveAsync
- getDeviceCameraAnalyticsLiveAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsLiveAsyncWithHttpInfo
- getDeviceCameraAnalyticsLiveWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsLiveWithHttpInfo
- getDeviceCameraAnalyticsOverview() : object
- Operation getDeviceCameraAnalyticsOverview
- getDeviceCameraAnalyticsOverviewAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsOverviewAsync
- getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo
- getDeviceCameraAnalyticsOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsOverviewWithHttpInfo
- getDeviceCameraAnalyticsRecent() : object
- Operation getDeviceCameraAnalyticsRecent
- getDeviceCameraAnalyticsRecentAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsRecentAsync
- getDeviceCameraAnalyticsRecentAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsRecentAsyncWithHttpInfo
- getDeviceCameraAnalyticsRecentWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsRecentWithHttpInfo
- getDeviceCameraAnalyticsZoneHistory() : object
- Operation getDeviceCameraAnalyticsZoneHistory
- getDeviceCameraAnalyticsZoneHistoryAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsZoneHistoryAsync
- getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo
- getDeviceCameraAnalyticsZoneHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsZoneHistoryWithHttpInfo
- getDeviceCameraAnalyticsZones() : object
- Operation getDeviceCameraAnalyticsZones
- getDeviceCameraAnalyticsZonesAsync() : PromiseInterface
- Operation getDeviceCameraAnalyticsZonesAsync
- getDeviceCameraAnalyticsZonesAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceCameraAnalyticsZonesAsyncWithHttpInfo
- getDeviceCameraAnalyticsZonesWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceCameraAnalyticsZonesWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getDeviceCameraAnalyticsLiveRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsLive'
- getDeviceCameraAnalyticsOverviewRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsOverview'
- getDeviceCameraAnalyticsRecentRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsRecent'
- getDeviceCameraAnalyticsZoneHistoryRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsZoneHistory'
- getDeviceCameraAnalyticsZonesRequest() : Request
- Create request for operation 'getDeviceCameraAnalyticsZones'
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 —getDeviceCameraAnalyticsLive()
Operation getDeviceCameraAnalyticsLive
public
getDeviceCameraAnalyticsLive(string $serial) : object
Returns live state from camera of analytics zones
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceCameraAnalyticsLiveAsync()
Operation getDeviceCameraAnalyticsLiveAsync
public
getDeviceCameraAnalyticsLiveAsync(string $serial) : PromiseInterface
Returns live state from camera of analytics zones
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsLiveAsyncWithHttpInfo()
Operation getDeviceCameraAnalyticsLiveAsyncWithHttpInfo
public
getDeviceCameraAnalyticsLiveAsyncWithHttpInfo(string $serial) : PromiseInterface
Returns live state from camera of analytics zones
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsLiveWithHttpInfo()
Operation getDeviceCameraAnalyticsLiveWithHttpInfo
public
getDeviceCameraAnalyticsLiveWithHttpInfo(string $serial) : array<string|int, mixed>
Returns live state from camera of analytics zones
Parameters
- $serial : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
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)
getDeviceCameraAnalyticsRecent()
Operation getDeviceCameraAnalyticsRecent
public
getDeviceCameraAnalyticsRecent(string $serial[, string $object_type = null ]) : object
Returns most recent record for analytics zones
Parameters
- $serial : string
-
serial (required)
- $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 —getDeviceCameraAnalyticsRecentAsync()
Operation getDeviceCameraAnalyticsRecentAsync
public
getDeviceCameraAnalyticsRecentAsync(string $serial[, string $object_type = null ]) : PromiseInterface
Returns most recent record for analytics zones
Parameters
- $serial : string
-
(required)
- $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 —getDeviceCameraAnalyticsRecentAsyncWithHttpInfo()
Operation getDeviceCameraAnalyticsRecentAsyncWithHttpInfo
public
getDeviceCameraAnalyticsRecentAsyncWithHttpInfo(string $serial[, string $object_type = null ]) : PromiseInterface
Returns most recent record for analytics zones
Parameters
- $serial : string
-
(required)
- $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 —getDeviceCameraAnalyticsRecentWithHttpInfo()
Operation getDeviceCameraAnalyticsRecentWithHttpInfo
public
getDeviceCameraAnalyticsRecentWithHttpInfo(string $serial[, string $object_type = null ]) : array<string|int, mixed>
Returns most recent record for analytics zones
Parameters
- $serial : string
-
(required)
- $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)
getDeviceCameraAnalyticsZoneHistory()
Operation getDeviceCameraAnalyticsZoneHistory
public
getDeviceCameraAnalyticsZoneHistory(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : object
Return historical records for analytic zones
Parameters
- $serial : string
-
serial (required)
- $zone_id : string
-
zone_id (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 14 hours 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 14 hours. The default is 1 hour. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (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 —getDeviceCameraAnalyticsZoneHistoryAsync()
Operation getDeviceCameraAnalyticsZoneHistoryAsync
public
getDeviceCameraAnalyticsZoneHistoryAsync(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface
Return historical records for analytic zones
Parameters
- $serial : string
-
(required)
- $zone_id : 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 14 hours 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 14 hours. The default is 1 hour. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (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 —getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo()
Operation getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo
public
getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface
Return historical records for analytic zones
Parameters
- $serial : string
-
(required)
- $zone_id : 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 14 hours 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 14 hours. The default is 1 hour. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (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 —getDeviceCameraAnalyticsZoneHistoryWithHttpInfo()
Operation getDeviceCameraAnalyticsZoneHistoryWithHttpInfo
public
getDeviceCameraAnalyticsZoneHistoryWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : array<string|int, mixed>
Return historical records for analytic zones
Parameters
- $serial : string
-
(required)
- $zone_id : 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 14 hours 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 14 hours. The default is 1 hour. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (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)
getDeviceCameraAnalyticsZones()
Operation getDeviceCameraAnalyticsZones
public
getDeviceCameraAnalyticsZones(string $serial) : object
Returns all configured analytic zones for this camera
Parameters
- $serial : string
-
serial (required)
Tags
Return values
object —getDeviceCameraAnalyticsZonesAsync()
Operation getDeviceCameraAnalyticsZonesAsync
public
getDeviceCameraAnalyticsZonesAsync(string $serial) : PromiseInterface
Returns all configured analytic zones for this camera
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsZonesAsyncWithHttpInfo()
Operation getDeviceCameraAnalyticsZonesAsyncWithHttpInfo
public
getDeviceCameraAnalyticsZonesAsyncWithHttpInfo(string $serial) : PromiseInterface
Returns all configured analytic zones for this camera
Parameters
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getDeviceCameraAnalyticsZonesWithHttpInfo()
Operation getDeviceCameraAnalyticsZonesWithHttpInfo
public
getDeviceCameraAnalyticsZonesWithHttpInfo(string $serial) : array<string|int, mixed>
Returns all configured analytic zones for this camera
Parameters
- $serial : 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
getDeviceCameraAnalyticsLiveRequest()
Create request for operation 'getDeviceCameraAnalyticsLive'
protected
getDeviceCameraAnalyticsLiveRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)
Tags
Return values
Request —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 —getDeviceCameraAnalyticsRecentRequest()
Create request for operation 'getDeviceCameraAnalyticsRecent'
protected
getDeviceCameraAnalyticsRecentRequest(string $serial[, string $object_type = null ]) : Request
Parameters
- $serial : string
-
(required)
- $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 —getDeviceCameraAnalyticsZoneHistoryRequest()
Create request for operation 'getDeviceCameraAnalyticsZoneHistory'
protected
getDeviceCameraAnalyticsZoneHistoryRequest(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : Request
Parameters
- $serial : string
-
(required)
- $zone_id : 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 14 hours 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 14 hours. The default is 1 hour. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (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 —getDeviceCameraAnalyticsZonesRequest()
Create request for operation 'getDeviceCameraAnalyticsZones'
protected
getDeviceCameraAnalyticsZonesRequest(string $serial) : Request
Parameters
- $serial : string
-
(required)