Interface IOrganizationsCameraDetections

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Camera Detections

public interface IOrganizationsCameraDetections

Methods

GetOrganizationCameraDetectionsHistoryByBoundaryByIntervalAsync(string, List<string>?, List<OrganizationCameraDetectionsHistoryRange>?, int?, int?, List<string>?, string?, CancellationToken)

Returns analytics data for timespans

[Get("/organizations/{organizationId}/camera/detections/history/byBoundary/byInterval")]
Task<List<OrganizationCameraDetectionsHistoryByBoundaryByIntervalItem>> GetOrganizationCameraDetectionsHistoryByBoundaryByIntervalAsync(string organizationId, List<string>? boundaryIds, List<OrganizationCameraDetectionsHistoryRange>? ranges, int? duration = null, int? perPage = 1000, List<string>? boundaryTypes = null, string? counterMode = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

boundaryIds List<string>

A list of boundary ids. The returned cameras will be filtered to only include these ids.

ranges List<OrganizationCameraDetectionsHistoryRange>

A list of time ranges with intervals

duration int?

The minimum time, in seconds, that the person or car remains in the area to be counted. Defaults to boundary configuration or 60.

perPage int?

The number of entries per page returned. Acceptable range is 1 - 1000. Defaults to 1000.

boundaryTypes List<string>

The detection types. Defaults to 'person'. enum = ["person", "vehicle"]

counterMode string

The filtering mode for Advanced People Counter. enum = ["all", "directions", "passages"]

cancellationToken CancellationToken

Returns

Task<List<OrganizationCameraDetectionsHistoryByBoundaryByIntervalItem>>

Exceptions

ApiException

Thrown when fails to make API call