Get SpO2 Intraday by Interval

This endpoint returns the SpO2 intraday data for a specified date range. SpO2 applies specifically to a user’s “main sleep”, which is the longest single period of time asleep on a given date. Spo2 values are calculated on a 5-minute exponentially-moving average.

The measurement is provided at the end of a period of sleep. The data returned usually reflects a sleep period that began the day before. For example, if you request SpO2 levels for 2021-12-22, it may include measurements that were taken the previous night on 2021-12-21 when the user fell asleep.

The data returned includes the percentage value of SpO2 in your bloodstream and an accurate timestamp for that measurement. It also uses units that correspond to the Accept-Language header provided.

Scope: oxygen_saturation

Request

• URL
• CURL

Response

• Description
• Example Response

[
    {
        "dateTime": "2021-10-01",
        "minutes": [
            {
                "value": 95.4,
                "minute": "2021-10-01T06:11:38"
            },
            {
                "value": 99.7,
                "minute": "2021-10-01T06:12:38"
            },
            {
                "value": 99.0,
                "minute": "2021-10-01T06:13:38"
            },
            ...
        ]
    },
    {
        "dateTime": "2021-10-02",
        "minutes": [
            {
                "value": 96.0,
                "minute": "2021-10-02T04:25:01"
            },
            {
                "value": 98.6,
                "minute": "2021-10-02T04:26:01"
            },
            {
                "value": 99.7,
                "minute": "2021-10-02T04:27:01"
            },

        ]
    },
    {
        "dateTime": "2021-10-03",
        "minutes": [
            {
                "value": 97.3,
                "minute": "2021-10-03T08:16:50"
            },
            {
                "value": 98.3,
                "minute": "2021-10-03T08:17:50"
            },
            {
                "value": 95.5,
                "minute": "2021-10-03T08:18:50"
            },
            ...
        ]
    },
    {
        "dateTime": "2021-10-04",
        "minutes": [
            {
                "value": 99.4,
                "minute": "2021-10-04T06:21:25"
            },
            {
                "value": 99.9,
                "minute": "2021-10-04T06:22:25"
            },
            {
                "value": 95.2,
                "minute": "2021-10-04T06:23:25"
            },
            ...
        ]
    }
]
      

Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.

Response Type

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Additional Information

Interval Intraday values reflect SpO2 measurement taken for periods of sleep between two dates. For most users, intraday values will span multiple dates to account for SpO2 levels on the date at which the summary was provided, and SpO2 levels during the previous night’s sleep.

Keep in mind, the intraday intervals have a maximum date range of 30 days. Entering a date range that exceeds 30 days will return a 400 Bad Request response code.

Collecting SpO2 data

SpO2 data is collected when the user is in an extended period of sleep. There are many factors that can affect a user’s SpO2 value. Recording the data while a person is asleep allows the Fitbit device to correctly and accurately collect SpO2 data. An extended sleep period is considered to be at least 3 hours of quality sleep. In addition, data is only processed when the user is still. If a user moves too much or their sleep session is too short, this can prevent SpO2 data from processing. See help article How do I track blood oxygen saturation (SpO2) with my Fitbit device? for more information on SpO2 data processing on the Fitbit device.

The device stops collecting SpO2 data after it determines the user is awake, typically through physical movements. Once the user syncs their device, we will begin processing the SpO2 data for that sleep period. It can take up to 1 hour for the SpO2 data to be processed and made available to download.

Subscription Support for SpO2

SpO2 does not support subscription notifications (webhooks). Since SpO2 is recorded during periods of sleep, the sleep notification arrival time can be used to estimate when the SpO2 data will be available (See the "Collecting Data" section). For applications that do not track sleep, or cannot retrieve sleep data, we recommend querying the SpO2 data once or twice a day to determine if new data is available (e.g. 12 noon and midnight).

Rate limit

The SpO2 endpoints are bound by our standard rate limit. See Rate Limits.

Device compatibility

The SpO2 data is retrieved from the user’s Fitbit account. This gives the user secure and transparent control over their data. The data is then processed and made available through the API after the user syncs their device with the Fitbit data service.

Most of the current devices sold support SpO2 data collection. See the Fitbit Product page to determine if your specific device supports SpO2.

Measurement units

SpO2 measurements are calculated as percentages. This is because blood oxygen saturation levels are most commonly and easily understood by users when referred to as percentages.

Get SpO2 Intraday by Date