Propose Zones by Accessory Id

Propose Zone definitions for an AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory.. This call will analyze the ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application. history for a given Accessory and propose a few zones of different categories. This call is not instantaneous and may take a few seconds to analyze the Activity history. A 200 return indicates enough data was found to make a proposal. A 201 return indicates not enough content was found.

The returned zones are unnamed and should be presented to the user for naming and confirmation. The zone data should then be saved via Set Zones by Accessory Id.

Permissions

Requires a Permissions scope of: circle:accessories

Requires the Accessory have a Circle SafeCircle Safe - A premium subscription which changes or adds additional Service Plan Features. There are many different types of Circle Safe plans. Some plans give the user longer storage via the Storage Length Feature for Activities. Other plans grant enhanced audio and video analytics for Activities via additional meta-data based on the Classifiers system. Circle Safe may be purchased directly through the Circle App or provisioned by a third-party system. enabled plan which contains the Zones Feature.

Response Body

Name

Type

Description

zones

array of Zone objects

The name field of each proposed Zone is always an empty string.

This object contains one extra field called tags which is an array of strings comprised of one or more of the following values:

entry - An entry or exit point, aka a doorway
busy - A high traffic location
empty - A low or no traffic location. The opposite of busy

confidence

integer

A number between 0 and 100 for how strong the proposal is. A value of 0 means there was only a small amount of data available. A 100 means almost all the motion in the history falls into these zones. It is not recommended to use this value directly in the UI.

Language
Authentication
OAuth2