Skip to content
Last updated

This document describes the user settings object schema on the backend.

Schema Structure

{
    "settings": {
        "reactivity_calibration": {
            "is_calibrated": <Boolean>,
            "dates": <Array<Date>>,
            "baseline": <Float>,
            "baseline_scaled": <Float>,
            "homeostasis_upper_limit": <Float>,
            "homeostasis_upper_limit_scaled": <Float>,
            "homeostasis_lower_limit": <Float>,
            "homeostasis_lower_limit_scaled": <Float>,
            "heart_rate_min": <Float>,
            "heart_rate_max": <Float>,
            "metadata": {
                "app_version": <String>,
                "algorithm_version": <String>
            }
        },
        "user_consent": {
            "data_sharing": <Boolean>
        },
        "onboarding": {
            "intention": 1
        }
    }
}

Field Descriptions

Reactivity Calibration Fields

FieldType
reactivity_calibration.is_calibratedBoolean
reactivity_calibration.datesArray<Date>
reactivity_calibration.baselineFloat
reactivity_calibration.baseline_scaledFloat
reactivity_calibration.homeostasis_upper_limitFloat
reactivity_calibration.homeostasis_upper_limit_scaledFloat
reactivity_calibration.homeostasis_lower_limitFloat
reactivity_calibration.homeostasis_lower_limit_scaledFloat
reactivity_calibration.heart_rate_minFloat
reactivity_calibration.heart_rate_maxFloat
reactivity_calibration.metadata.app_versionString
reactivity_calibration.metadata.algorithm_versionString
FieldType
user_consent.data_sharingBoolean

Onboarding Fields

intention
{
    1: STRESS,
    2: POSTITIVE,
    3: HEALTH,
    4: HABITS,
    5: FRIENDS / RELATIONSHIPS,
    6: ENERGY
}

Example

{
    "settings": {
        "reactivity_calibration": {
            "is_calibrated": true,
            "dates": ["2024-11-01", "2024-11-02", "2024-11-03"],
            "baseline": 45.2,
            "baseline_scaled": 0.52,
            "homeostasis_upper_limit": 65.8,
            "homeostasis_upper_limit_scaled": 0.78,
            "homeostasis_lower_limit": 38.4,
            "homeostasis_lower_limit_scaled": 0.42,
            "heart_rate_min": 58.0,
            "heart_rate_max": 142.0,
            "metadata": {
                "app_version": "2.5.1",
                "algorithm_version": "1.3.0"
            }
        },
        "user_consent": {
            "data_sharing": true
        },
        "oboarding": {
            "intention": 1
        }
    }
}