Skip to content
AF
Google Health API reference

Total Calories: the Google Health API total-calories 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

Total Calories (total-calories) is an Interval data type in the Google Health API. Google's data-types table lists rollup and dailyRollup for it under the .activity_and_fitness.readonly and .activity_and_fitness.writeonly scopes, with a storage resolution of 1 minute. The table marks it with true-zeros support. Google's Fitbit migration table maps the Fitbit Web API's Activity caloriesOut data to it.

Total Calories at a glance

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

Display name
Total Calories
dataType (in endpoint URLs)
total-calories
filter parameter
total_caloriesGoogle: “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
1 minute
Webhook support
Not marked in Google’s table
True zeros support
Yes
Channel
v4
DataPoint field
none in the discovery documents — see the flags below
Compatible devices
28 in Google’s table

Operations and request paths

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

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

Scopes

The scopes Google’s table lists for total-calories, 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.

Rollup fields

rollUp returns RollupDataPoint.totalCalories

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

TotalCaloriesRollupValue — Google: “Represents the result of the rollup of the user's total calories. Note: Queries for the total-calories data type must include a time interval filter (such as total_calories.interval.start_time or total_calories.interval.civil_start_time). The maximum range is 14 days. Example filter query: total_calories.interval.start_time >= "2026-04-20T00:00:00Z" AND total_calories.interval.start_time < "2026-04-21T00:00:00Z"”

FieldTypeGoogle’s description
kcalSumnumber/doubleSum of the total calories in kilocalories.

dailyRollUp returns DailyRollupDataPoint.totalCalories

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

The same TotalCaloriesRollupValue as the rollUp result above.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table maps Activity caloriesOut to total-calories. Google’s note: “The complete number of calories burned by a user over a period of time, inclusive of basal metabolic rate and active energy burned.”

Fitbit Web API scopes Google maps to total-calories’s scopes: activity, cardio_fitness.

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

Where Google’s guides name total-calories

  • “Filter requirements: Some read-only derived data types, such as total-calories, require a filter specifying an interval start time (using physical or civil time).”Google's data-types page, “Query constraints”
  • “A maximum query range of 14 days for calories-in-heart-rate-zone, heart-rate, active-minutes, and total-calories.”Google's data-types page, “Query constraints”
  • “A maximum range of 14 days for calories-in-heart-rate-zone, heart-rate, active-minutes, and total-calories.”Google's endpoints guide, “Query historical data”

Where Google’s pages disagree

Published as found, with the texts that disagree; nothing here is corrected by us.

  • No v4 DataPoint field

    Neither discovery document has a DataPoint property for total-calories; it exists only as a rollup (totalCalories), matching the table's operations (rollup, dailyRollup).

    • Google's data-types page: “Total Calories”
    • Google's data-types page: “rollup, dailyRollup”
    • the v4 discovery document: “Returned by default when rolling up data points from the total-calories data type, or when requested explicitly using the total-calories rollup type identifier.”
  • Release note and webhook pages differ

    Google's release notes for April 14, 2026 list totalCalories under webhook notification support; the data-types table and the webhooks page do not list total-calories as webhook-supported.

    • Google's release notes: “Notification support for the data types activeZoneMinutes, altitude, bodyFat, caloriesInHeartRateZone, dailyHeartRateVariability, dailyHeartRateZones, dailyOxygenSaturation, dailyRestingHeartRate, dailySleepTemperatureDerivations, distance, exercise, floors, heartRate, sleep, steps, totalCalories, and weight.”

Compatible devices

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

  • 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 total-calories 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 total-calories. 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 total calories data to the Google Health API?

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

How do you aggregate total-calories 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/total-calories/dataPoints:rollUp) returns RollupDataPoint.totalCalories, a TotalCaloriesRollupValue with kcalSum; dailyRollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/total-calories/dataPoints:dailyRollUp) returns DailyRollupDataPoint.totalCalories, a TotalCaloriesRollupValue with kcalSum. Each field is described on this page as the discovery document describes it.

What did the Google Health API total-calories data type replace in the Fitbit Web API?

Google's Fitbit Web API migration table maps the Fitbit Web API's "Activity caloriesOut" to total-calories. Google's note on the row: "The complete number of calories burned by a user over a period of time, inclusive of basal metabolic rate and active energy burned." 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