Oxygen Saturation: the Google Health API oxygen-saturation data type

Oxygen Saturation at a glance

From the Oxygen Saturation row of Google’s data-types table, joined to the discovery document’s DataPoint schema.

Display name

Oxygen Saturation

dataType (in endpoint URLs)

oxygen-saturation

filter parameter

oxygen_saturationGoogle: “The identifier separated by underscores (for example, active_minutes) used as the value for the dataType filter parameter in daily rollup and rollup requests.”

Record type

Sample — Google: “Represents instantaneous measurements.”

Storage resolution

1 minute

Webhook support

Not marked in Google’s table

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

DataPoint.oxygenSaturation → OxygenSaturationIts description: “Optional. Data for points in the oxygen-saturation sample data type collection.”

Compatible devices

16 in Google’s table

Operations and request paths

The operations Google’s table lists for oxygen-saturation, each matched to its users.dataTypes.dataPoints method in the discovery document. The path is the documented path template (the method’s flatPath on https://health.googleapis.com/) with {dataTypesId} filled in as oxygen-saturation. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Every method, and how many of the data types list it: the methods overview.

Scopes

The scopes Google’s table lists for oxygen-saturation, as full URLs, with the consent text Google’s Scopes page gives each. Every Google Health API scope.

Fields of Oxygen Saturation

The schema the discovery document gives DataPoint.oxygenSaturation, required fields first. Types are as the discovery document states them; the label is the word Google’s description opens with. The schemas its fields refer to follow, one level deep.

Fitbit Web API predecessor

Fitbit Web API scopes Google maps to oxygen-saturation’s scopes: blood_glucose, heartrate, oxygen_saturation, respiratory_rate, temperature, weight.

Google’s full Fitbit Web API mapping tables · the migration playbook

Where Google’s guides name oxygen-saturation

• “For minute-level blood oxygen saturation (oxygen-saturation), the API returns only validated readings and removes minutes marked invalid due to arm movement, a loose wrist fit, or a sensor confidence score under 50%, as well as the 3 minutes before and after an invalid reading and isolated valid stretches shorter than 4 minutes. As a result, minute-level coverage can be sparse and gaps are expected. For details, see Minute-level SpO2 filtering and data validity.”Google's data-types page, “Data quality and validity filtering”
• “When querying minute-level blood oxygen saturation (oxygen-saturation), the Google Health API applies stricter data validity filtering than the legacy Fitbit Web API:”Google's Fitbit migration API specifications, “Oxygen saturation filtering”
• “Because the Google Health API removes all invalid measurements rather than only the 50% sentinel value, it returns fewer oxygen-saturation data points than the Fitbit Web API for the same time range, and gaps in minute-by-minute coverage are expected. The returned minute-level readings align with the validated data points used to compute the user's daily-oxygen-saturation sleep summary. For more information, see Minute-level SpO2 filtering and data validity.”Google's Fitbit migration API specifications, “Oxygen saturation filtering”

Compatible devices

The 16 devices Google’s table lists as able to record and sync oxygen-saturation.

• Fitbit Air
• Fitbit Charge 4
• Fitbit Charge 5
• Fitbit Charge 6
• Fitbit Inspire 3
• Fitbit Ionic
• Fitbit Luxe
• Pixel Watch 2
• Pixel Watch 3
• Pixel Watch 4
• Fitbit Sense
• Fitbit Sense 2
• Fitbit Versa
• Fitbit Versa 2
• Fitbit Versa 3
• Fitbit Versa 4