v1

latestOpenAPI 3.1.02026-07-136587849.3 KB

Queries / Statistics

Statistics by interpolation

get/queries/statistics/interpolation

Query parameters

from_timestampstring date-time

Start time of the query range in UTC, inclusive

Example:2006-01-02T15:04:05

Start time of the query range in UTC, inclusive

to_timestampstring date-time

End time of the query range in UTC, non-inclusive

Example:2006-01-02T15:04:05

End time of the query range in UTC, non-inclusive

interval'5m' | '15m' | '30m' | '1h'

Interval of the query

exclude_manualboolean

Exclude manual metrics from the statistics

typesstring[] required

providersstring[]

include_record_idsboolean

Whether to include the record IDs in the response

device_typesstring[]

Device types to include in the statistics

Response

from_timestampstring date-time

to_timestampstring date-time

Example response

{
  "from_timestamp": "2006-01-02T00:00:00Z",
  "statistics": [
    {
      "from_timestamp": "2006-01-02T00:00:00Z",
      "record_ids": [
        "12345678-1234-abcd-4321-abcdef123456"
      ],
      "to_timestamp": "2006-01-02T00:00:00Z",
      "values": {
        "activity_score": 83,
        "calories_burned_active": 1020.0991,
        "calories_burned_basal": 2000.1242,
        "calories_burned_total": 3020.2233,
        "distance_cycling": 20091.0022,
        "distance_running": 12000.1014,
        "distance_total": 5880.7021,
        "distance_walking": 1200.7022,
        "duration_high_intensity": 1200000,
        "duration_low_intensity": 9000000,
        "duration_moderate_intensity": 2400000,
        "heartrate": 100,
        "heartrate_max": 120,
        "heartrate_min": 60,
        "heartrate_resting": 60,
        "hrv_rmssd": 45,
        "hrv_sdnn": 52,
        "recovery_score": 83,
        "sleep_duration_total": 3600000,
        "sleep_score": 70,
        "sleep_skin_temperature_deviation": -0.13,
        "steps": 10000,
        "stress_score": 70
      }
    }
  ],
  "to_timestamp": "2006-01-02T00:00:00Z"
}