Interface ICameraAnalyticsZones

Namespace

Meraki.Api.Interfaces.Products.Camera

Assembly

Meraki.Api.dll

public interface ICameraAnalyticsZones

Methods

GetDeviceCameraAnalyticsZoneHistoryAsync(string, string, string, string, double?, int?, string, CancellationToken)

Return historical records for analytic zones

[Get("/devices/{serial}/camera/analytics/zones/{zoneId}/history")]
Task<List<CameraZoneHistory>> GetDeviceCameraAnalyticsZoneHistoryAsync(string serial, string zoneId, string t0 = null, string t1 = null, double? timespan = null, int? resolution = null, string objectType = null, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

zoneId string

The zone id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

t1 string

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

timespan double?

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?

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

objectType string

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

cancellationToken CancellationToken

Returns

Task<List<CameraZoneHistory>>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceCameraAnalyticsZonesAsync(string, CancellationToken)

Returns all configured analytic zones for this camera

[Get("/devices/{serial}/camera/analytics/zones")]
Task<List<CameraZone>> GetDeviceCameraAnalyticsZonesAsync(string serial, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

cancellationToken CancellationToken

Returns

Task<List<CameraZone>>

Exceptions

ApiException

Thrown when fails to make API call