home api list

Hexostore API Documentation

zone

/api/profile/[profile_id]/zone

List methods: get

Detail methods: get

User-specific zones that help classify: KPIs, metrics, and datatypes.

Example: A user has a hr_rest of 60 and a HR_max of 175. The zone #2 defines the heart rate training zone. 5 bins are defined:

  1. [60, 129] Zone = 1. 60 <= HR < 129
  2. [129, 141] Zone = 2. 129 <= HR < 141
  3. [141, 152] Zone = 3. 141 <= HR < 152
  4. [152, 164] Zone = 4. 152 <= HR < 164
  5. [164, 175] Zone = 5. 175 <= HR < 175

Zone 0, out of bound. HR < 60 Zone 6, out of bound. HR > 175

Fields

activitytype:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field is readonly.

datatype:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field is readonly.

id:

The primary key for this resource. Integer data. Ex: 2673

This field is readonly.

metric:

A reference to the resource. Maybe specified by URI or ID. Using a URI is recommended.

This field is readonly.

Filtering Options

datatype: exact, in, range, isnull

id: exact, in, range

metric: exact, in, range, isnull

A reference to metric by ID.

start: exact

This is not a filtering field but the timestamp where the zones are extracted

Sorting Options

No sorting supported

© 2024 by CarrĂ© Technologies Inc.