Interface ICameraAnalyticsOverview

Namespace

Meraki.Api.Interfaces.Products.Camera

Assembly

Meraki.Api.dll

public interface ICameraAnalyticsOverview

Methods

GetDeviceCameraAnalyticsOverviewAsync(string, string, string, double?, string, CancellationToken)

Returns an overview of aggregate analytics data for a timespan

[Get("/devices/{serial}/camera/analytics/overview")]
[Obsolete("This endpoint is deprecated and will be removed in a future update. Please use the new camera/analytics/overview endpoint.", false)]
Task<List<CameraOverview>> GetDeviceCameraAnalyticsOverviewAsync(string serial, string t0 = null, string t1 = null, double? timespan = null, string objectType = null, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

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 7 days 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 7 days. The default is 1 hour. (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<CameraOverview>>

Exceptions

ApiException

Thrown when fails to make API call