Skip to content
AF
Google Health API reference

Sedentary Period: the Google Health API sedentary-period 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

Sedentary Period (sedentary-period) is an Interval data type in the Google Health API. Google's data-types table lists list, reconcile, rollup and dailyRollup for it under the .activity_and_fitness.readonly and .activity_and_fitness.writeonly scopes. The table marks it with webhook support. Google's Fitbit migration table maps the Fitbit Web API's Activity time series minutes sedentary data to it.

Sedentary Period at a glance

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

Display name
Sedentary Period
dataType (in endpoint URLs)
sedentary-period
filter parameter
sedentary_periodGoogle: “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
Interval — Google: “Represents measurements recorded over a duration.”
Storage resolution
not stated in Google’s table
Webhook support
Yes · automatic-subscription token WEBHOOK_DATA_TYPE_SEDENTARY_PERIOD
True zeros support
Not marked in Google’s table
Channel
v4
DataPoint field
DataPoint.sedentaryPeriod → SedentaryPeriodIts description: “Optional. Data for points in the sedentary-period interval data type collection.”
Compatible devices
28 in Google’s table

Operations and request paths

The operations Google’s table lists for sedentary-period, 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 sedentary-period. 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/sedentary-period/dataPoints
reconcilereconcileGET https://health.googleapis.com/v4/users/{usersId}/dataTypes/sedentary-period/dataPoints:reconcile
rolluprollUpsame name, different casePOST https://health.googleapis.com/v4/users/{usersId}/dataTypes/sedentary-period/dataPoints:rollUp
dailyRollupdailyRollUpsame name, different casePOST https://health.googleapis.com/v4/users/{usersId}/dataTypes/sedentary-period/dataPoints:dailyRollUp

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

Scopes

The scopes Google’s table lists for sedentary-period, 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.activity_and_fitness.readonlyreadSee your Google Health activity and fitness data.
https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonlywriteAdd activity and fitness data to Google Health, and edit or delete the data it adds.

Fields of Sedentary Period

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

SedentaryPeriod — Google: “SedentaryPeriod SedentaryPeriod data represents the periods of time that the user was sedentary (i.e. not moving while wearing the device).”

FieldTypeGoogle’s description
intervalRequiredObservationTimeIntervalRequired. Observed interval.

ObservationTimeInterval

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

FieldTypeGoogle’s description
endTimeRequiredstring/google-datetimeRequired. Observed interval end time.
endUtcOffsetRequiredstring/google-durationRequired. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
startTimeRequiredstring/google-datetimeRequired. Observed interval start time.
startUtcOffsetRequiredstring/google-durationRequired. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
civilEndTimeOutput onlyCivilDateTimeOutput only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
civilStartTimeOutput onlyCivilDateTimeOutput only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval

Rollup fields

rollUp returns RollupDataPoint.sedentaryPeriod

The discovery document: “Returned by default when rolling up data points from the sedentary-period data type, or when requested explicitly using the sedentary-period rollup type identifier.”

SedentaryPeriodRollupValue — Google: “Represents the result of the rollup of the user's sedentary periods.”

FieldTypeGoogle’s description
durationSumstring/google-durationThe total time user spent sedentary during the interval.

dailyRollUp returns DailyRollupDataPoint.sedentaryPeriod

The discovery document: “Returned by default when rolling up data points from the sedentary-period data type, or when requested explicitly using the sedentary-period rollup type identifier.”

The same SedentaryPeriodRollupValue as the rollUp result above.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table maps Activity time series minutes sedentary to sedentary-period.

Fitbit Web API scopes Google maps to sedentary-period’s scopes: activity, cardio_fitness.

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

Compatible devices

The 28 devices Google’s table lists as able to record and sync sedentary-period.

  • Fitbit Air
  • Fitbit Alta
  • Fitbit Alta HR
  • Fitbit Blaze
  • Fitbit Charge 2
  • Fitbit Charge 3
  • Fitbit Charge 4
  • Fitbit Charge 5
  • Fitbit Charge 6
  • Fitbit Flex 2
  • Fitbit Inspire
  • Fitbit Inspire 2
  • Fitbit Inspire 3
  • Fitbit Inspire HR
  • Fitbit Ionic
  • Fitbit Luxe
  • Fitbit MobileTrack
  • 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
  • Fitbit Versa Lite

Google’s documentation

Related on this site

Questions

Which OAuth scopes does the Google Health API sedentary-period data type need?

Google's data-types table (read 2026-10-17) lists https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly and https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly for sedentary-period. The Scopes page's consent text: .activity_and_fitness.readonly, "See your Google Health activity and fitness data."; .activity_and_fitness.writeonly, "Add activity and fitness data to Google Health, and edit or delete the data it adds."

Can apps write sedentary period data to the Google Health API?

Not according to Google's data-types table, read 2026-10-17: it lists only list, reconcile, rollup and dailyRollup for sedentary-period, and no create, update or batchDelete operation.

How do you aggregate sedentary-period data with the Google Health API?

With the rollup methods Google's table lists for it. rollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/sedentary-period/dataPoints:rollUp) returns RollupDataPoint.sedentaryPeriod, a SedentaryPeriodRollupValue with durationSum; dailyRollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/sedentary-period/dataPoints:dailyRollUp) returns DailyRollupDataPoint.sedentaryPeriod, a SedentaryPeriodRollupValue with durationSum. Each field is described on this page as the discovery document describes it.

What did the Google Health API sedentary-period data type replace in the Fitbit Web API?

Google's Fitbit Web API migration table maps the Fitbit Web API's "Activity time series minutes sedentary" to sedentary-period. The Fitbit Web API scopes Google maps to its scopes: activity and cardio_fitness.

Other activity and fitness data types

All activity and fitness 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