Skip to content
AF
Google Health API reference

Respiratory Rate Sleep Summary: the Google Health API respiratory-rate-sleep-summary data type

Read from Google’s documentation on 2026-10-17 · discovery document revision 20261014 · Google’s data-types page last updated 2026-10-06

Respiratory Rate Sleep Summary (respiratory-rate-sleep-summary) is a Sample data type in the Google Health API. Google's data-types table lists list and reconcile for it under the .health_metrics_and_measurements.readonly and .health_metrics_and_measurements.writeonly scopes. The table marks it with webhook support. Google's Fitbit migration table names no Fitbit Web API predecessor for it.

Respiratory Rate Sleep Summary at a glance

From the Respiratory Rate Sleep Summary row of Google’s data-types table, joined to the discovery document’s DataPoint schema.

Display name
Respiratory Rate Sleep Summary
dataType (in endpoint URLs)
respiratory-rate-sleep-summary
filter parameter
respiratory_rate_sleep_summaryGoogle: “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
not stated in Google’s table
Webhook support
Yes · automatic-subscription token WEBHOOK_DATA_TYPE_RESPIRATORY_RATE_SLEEP_SUMMARY
True zeros support
Not marked in Google’s table
Channel
v4
DataPoint field
DataPoint.respiratoryRateSleepSummary → RespiratoryRateSleepSummaryIts description: “Optional. Data for points in the respiratory-rate-sleep-summary sample data type collection.”
Compatible devices
23 in Google’s table

Operations and request paths

The operations Google’s table lists for respiratory-rate-sleep-summary, 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 respiratory-rate-sleep-summary. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Table listsMethodDocumented path template
listlistGET https://health.googleapis.com/v4/users/{usersId}/dataTypes/respiratory-rate-sleep-summary/dataPoints
reconcilereconcileGET https://health.googleapis.com/v4/users/{usersId}/dataTypes/respiratory-rate-sleep-summary/dataPoints:reconcile

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

Scopes

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

ScopeAccessGoogle’s permission text
https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonlyreadSee your Google Health health metrics and measurement data.
https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonlywriteAdd health metric and measurements data to Google Health, and edit or delete the data it adds.

Fields of Respiratory Rate Sleep Summary

The schema the discovery document gives DataPoint.respiratoryRateSleepSummary, 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.

RespiratoryRateSleepSummary — Google: “Records respiratory rate details during sleep. Can have multiple per day if the user sleeps multiple times.”

FieldTypeGoogle’s description
fullSleepStatsRequiredRespiratoryRateSleepSummaryStatisticsRequired. Full respiratory rate statistics.
sampleTimeRequiredObservationSampleTimeRequired. The time at which respiratory rate was measured.
deepSleepStatsOptionalRespiratoryRateSleepSummaryStatisticsOptional. Respiratory rate statistics for deep sleep.
lightSleepStatsOptionalRespiratoryRateSleepSummaryStatisticsOptional. Respiratory rate statistics for light sleep.
remSleepStatsOptionalRespiratoryRateSleepSummaryStatisticsOptional. Respiratory rate statistics for REM sleep.

RespiratoryRateSleepSummaryStatistics

Google: “Respiratory rate statistics for a given sleep stage.”

FieldTypeGoogle’s description
breathsPerMinuteRequirednumber/doubleRequired. Average breaths per minute.
signalToNoiseOptionalnumber/doubleOptional. How trustworthy the data is for the computation.
standardDeviationOptionalnumber/doubleOptional. Standard deviation of the respiratory rate during sleep.

ObservationSampleTime

Google: “Represents a sample time of an observed data point.”

FieldTypeGoogle’s description
physicalTimeRequiredstring/google-datetimeRequired. The time of the observation.
utcOffsetRequiredstring/google-durationRequired. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
civilTimeOutput onlyCivilDateTimeOutput only. The civil time in the timezone the subject is in at the time of the observation.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table has no row for respiratory-rate-sleep-summary, so it names no Fitbit Web API predecessor.

Fitbit Web API scopes Google maps to respiratory-rate-sleep-summary’s scopes: blood_glucose, heartrate, oxygen_saturation, respiratory_rate, temperature, weight.

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

Compatible devices

The 23 devices Google’s table lists as able to record and sync respiratory-rate-sleep-summary.

  • Fitbit Air
  • Fitbit Alta HR
  • Fitbit Blaze
  • Fitbit Charge 2
  • Fitbit Charge 3
  • Fitbit Charge 4
  • Fitbit Charge 5
  • Fitbit Charge 6
  • Fitbit Inspire 2
  • Fitbit Inspire 3
  • Fitbit Inspire HR
  • Fitbit Ionic
  • Fitbit Luxe
  • Pixel Watch
  • 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

Google’s documentation

Related on this site

Questions

Which OAuth scopes does the Google Health API respiratory-rate-sleep-summary data type need?

Google's data-types table (read 2026-10-17) lists https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly and https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly for respiratory-rate-sleep-summary. The Scopes page's consent text: .health_metrics_and_measurements.readonly, "See your Google Health health metrics and measurement data."; .health_metrics_and_measurements.writeonly, "Add health metric and measurements data to Google Health, and edit or delete the data it adds."

Can apps write respiratory rate sleep summary data to the Google Health API?

Not according to Google's data-types table, read 2026-10-17: it lists only list and reconcile for respiratory-rate-sleep-summary, and no create, update or batchDelete operation.

How do you aggregate respiratory-rate-sleep-summary data with the Google Health API?

Not with rollUp or dailyRollUp, going by Google's data-types table: it lists only list and reconcile for respiratory-rate-sleep-summary. Read the data points with list (or reconcile, where listed) and compute any summary yourself.

Does the Google Health API send webhooks for respiratory-rate-sleep-summary?

Yes. Google's data-types table marks respiratory-rate-sleep-summary with webhook support, the webhooks guide lists it, and automatic subscriptions name it with the token WEBHOOK_DATA_TYPE_RESPIRATORY_RATE_SLEEP_SUMMARY.

Other health metrics and measurements data types

All health metrics and measurements data types →

Sources checked

Google’s text is quoted for identification; each guide page’s footer reads: “Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.”. Generated from Google’s pages by scripts/fetch-google-health-api.mjs, not typed by hand; Google’s documentation remains the authority.

← All Google Health API data types