Documentation Index
Fetch the complete documentation index at: https://docs.spikeapi.com/llms.txt
Use this file to discover all available pages before exploring further.
Statistics
The following table lists all the statistics available, along with their descriptions, applicable methods, associated metrics, units of measurement, and number of decimals for output precision.| Label | Description | Methods | Metrics | Unit | Precision |
|---|---|---|---|---|---|
| calories_burned_active | Calories burned during active periods | intersect_sum | calories_burned_active | kcal | 4 |
| calories_burned_basal | Calories burned at rest (basal metabolic rate) | intersect_sum | calories_burned_basal | kcal | 4 |
| calories_burned_total | Total calories burned including basal and active periods | intersect_union_sum | calories_burned calories_burned_basal calories_burned_active | kcal | 4 |
| distance_cycling | Total distance covered while cycling | intersect_sum | distance_cycling | meters | 4 |
| distance_running | Total distance covered while running | intersect_sum | distance_running | meters | 4 |
| distance_total | Total distance covered across all activities | intersect_union_sum | distance distance_walking distance_cycling distance_running | meters | 4 |
| distance_walking | Total distance covered while walking | intersect_sum | distance_walking | meters | 4 |
| duration_high_intensity | Duration of high level intensity | intersect_sum | duration_high_intensity | ms | 0 |
| duration_low_intensity | Duration of low level intensity | intersect_sum | duration_low_intensity | ms | 0 |
| duration_moderate_intensity | Duration of medium level intensity | intersect_sum | duration_moderate_intensity | ms | 0 |
| heartrate | Average heart rate over a period | duration_weighted_avg | heartrate | bpm | 0 |
| heartrate_max | Maximum recorded heart rate, providing insights into peak values | max | heartrate | bpm | 0 |
| heartrate_min | Minimum recorded heart rate, providing insights into lowest values | min | heartrate | bpm | 0 |
| heartrate_resting | Average resting heart rate | duration_weighted_avg | heartrate_resting | bpm | 0 |
| hrv_rmssd | Heart rate variability measured by RMSSD | duration_weighted_avg | hrv_rmssd | ms | 0 |
| hrv_sdnn | Heart rate variability measured by SDNN | duration_weighted_avg | hrv_sdnn | ms | 0 |
| sleep_duration_total | Total sleep duration across all sleep stages | intersect_union_sum | sleep_duration_deep sleep_duration_light sleep_duration_rem sleep_duration_awake | ms | 0 |
| sleep_score | Overall sleep score based on various sleep metrics | sleep_score | bedtime_duration sleep_duration sleep_duration_nap sleep_duration_light sleep_duration_deep sleep_duration_rem sleep_duration_awake sleep_interruptions sleep_efficiency sleep_latency sleep_breathing_rate | count | 0 |
| sleep_skin_temperature_deviation | Sleep skin temperature deviation from the baseline | intersect_sum | sleep_skin_temperature_deviation | celsius | 2 |
| steps | Total number of steps taken | intersect_sum | steps | count | 0 |
Methods
The table below provides details on the various methods used in the statistics, including a brief description of each.| Label | Description |
|---|---|
| duration_weighted_avg | Average of values weighted by their duration, ensuring longer durations have a greater impact on the average. |
| intersect_sum | Sum of intersecting values of specified metrics, aggregating overlapping data points to provide a total count or sum. |
| intersect_union_sum | Sum of the union of intersecting values, merging several metrics to provide a comprehensive aggregation across multiple metrics. |
| max | Maximum value of the specified metrics, providing insights into the peak values recorded. |
| min | Minimum value of the specified metrics, providing insights into the lowest values recorded. |
| sleep_score | A score representing the quality of sleep, calculated using intersecting values. |