POpolar-com
Elixir™ Biosensing

SpO2 test result data

Changed on

Get user's SpO2 test result data for last 28 days or for given date range. Maximum date range between from and to cannot be more than 28 days.

get/v3/users/biosensing/spo2

Request

Query parameters

fromstring date

Inclusive start date of range as ISO-8601 date string, example: "2023-10-01"

tostring date

Inclusive end date of range as ISO-8601 date string, example: "2023-10-28"

Response

Request was successful.

source_device_idstring
test_timeinteger
time_zone_offsetinteger
test_status'SPO2_TEST_PASSED' | 'SPO2_TEST_INCONCLUSIVE_TOO_LOW_QUALITY_IN_SAMPLES' | 'SPO2_TEST_INCONCLUSIVE_TOO_LOW_OVERALL_QUALITY' | 'SPO2_TEST_INCONCLUSIVE_TOO_MANY_MISSING_SAMPLES'
blood_oxygen_percentinteger
spo2_class'SPO2_CLASS_UNKNOWN' | 'SPO2_CLASS_VERY_LOW' | 'SPO2_CLASS_LOW' | 'SPO2_CLASS_NORMAL'
spo2_value_deviation_from_baseline'DEVIATION_NO_BASELINE' | 'DEVIATION_BELOW_USUAL' | 'DEVIATION_USUAL' | 'DEVIATION_ABOVE_USUAL'
spo2_quality_average_percentnumber float
average_heart_rate_bpminteger
heart_rate_variability_msnumber float
spo2_hrv_deviation_from_baseline'DEVIATION_NO_BASELINE' | 'DEVIATION_BELOW_USUAL' | 'DEVIATION_USUAL' | 'DEVIATION_ABOVE_USUAL'
altitude_metersnumber float

Example response

[
  {
    "source_device_id": "1111AAAA",
    "test_time": 1697787256,
    "time_zone_offset": 180,
    "test_status": "SPO2_TEST_PASSED",
    "blood_oxygen_percent": 95,
    "spo2_class": "SPO2_CLASS_NORMAL",
    "spo2_value_deviation_from_baseline": "DEVIATION_NO_BASELINE",
    "spo2_quality_average_percent": 90,
    "average_heart_rate_bpm": 60,
    "heart_rate_variability_ms": 100,
    "spo2_hrv_deviation_from_baseline": "DEVIATION_NO_BASELINE",
    "altitude_meters": 50
  }
]

Changes

  • 18ce96365320Revision changes
    • breaking

      the / response's property format changed from uint32 to int32 for status

  • f197848bba31Revision changes
    • info

      api tag Elixir™ Biosensing added

    • info

      api tag Elixir™ Biosensing (Beta) removed