Propose Zones by Accessory Id

Propose Zone definitions for an Accessory. This call will analyze the Activity 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 Safe 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