Google

Google Health API

The Google Health API lets you view and manage health and fitness metrics and measurement data.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Google Health API lets you view and manage health and fitness metrics and measurement data.

Endpoints 17

projects.subscribers

  • GETLists all subscribers registered within the owned Google Cloud Project./v4/:parent/subscribers?pageSize=0&pageToken=stringLists all subscribers registered within the owned Google Cloud Project.
  • POSTRegisters a new subscriber endpoint to receive notifications/v4/:parent/subscribers?subscriberId=stringRegisters a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change…

users.pairedDevices

  • GETReturns user's Device./v4/:nameReturns user's Device.
  • GETReturns the user's list of paired 1P trackers and smartwatches./v4/:parent/pairedDevices?pageSize=0&pageToken=stringReturns the user's list of paired 1P trackers and smartwatches.

projects.subscribers.subscriptions

  • DELETEDeletes a specific user subscription, stopping notifications for this user to this subscriber./v4/:nameDeletes a specific user subscription, stopping notifications for this user to this subscriber.
  • GETLists all active subscriptions for a given subscriber/v4/:parent/subscriptions?filter=string&pageSize=0&pageToken=stringLists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
  • POSTCreates a subscription for a specific user to a specific subscriber/v4/:parent/subscriptions?subscriptionId=stringCreates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for…

users.dataTypes.dataPoints

  • PATCHUpdates a single identifiable data point/v4/:nameUpdates a single identifiable data point. If a data point with the specified name is not found, the request will fail.
  • POSTDelete a batch of identifyable data points./v4/:parent/dataPoints:batchDeleteDelete a batch of identifyable data points.
  • GETQuery user health and fitness data points./v4/:parent/dataPoints?dataSourceFamily=string&filter=string&pageSize=0&pageToken=stringQuery user health and fitness data points.
  • POSTCreates a single identifiable data point./v4/:parent/dataPointsCreates a single identifiable data point.
  • POSTRoll up data points over civil time intervals for supported data types./v4/:parent/dataPoints:dailyRollUpRoll up data points over civil time intervals for supported data types.
  • GETExports exercise data in TCX format/v4/:name:exportExerciseTcx?partialData=trueExports exercise data in TCX format. IMPORTANT: HTTP clients must append ?alt=media to the request URL to download the raw TCX file. ## Examples: ##…
  • GETReconcile data points from multiple data sources into a single data stream./v4/:parent/dataPoints:reconcile?dataSourceFamily=string&filter=string&pageSize=0&pageToken=stringReconcile data points from multiple data sources into a single data stream.
  • POSTRoll up data points over physical time intervals for supported data types./v4/:parent/dataPoints:rollUpRoll up data points over physical time intervals for supported data types.

shl.m

  • POSTForward a manifest request for a given SHL/v4/shl/m/:externalShlIdForward a manifest request for a given SHL

shl.r

  • GETForward a resource request for a given SHL/v4/shl/r/:externalShlId/:resourceTokenForward a resource request for a given SHL

API details

Base URL
https://health.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 21 scopes
An API key in the key query parameter
Operations
17 operations on 12 pathsGET 8POST 7PATCH 1DELETE 1
Main resources
users.dataTypes.dataPoints 8projects.subscribers.subscriptions 3projects.subscribers 2users.pairedDevices 2shl.m 1shl.r 1
Response formats
application/json
Description format
Google API Discovery, API version v4

How to test the Google Health API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Google Health API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 21 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists all subscribers registered within the owned Google Cloud Project.” (GET /v4/:parent/subscribers?pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Google Health API?

The Google Health API lets you view and manage health and fitness metrics and measurement data. It is listed under Developer tools and has 17 endpoints.

Who publishes the Google Health API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Google Health API?

Requests go to https://health.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Google Health API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 21 scopes; an API key in the key query parameter.

How many endpoints does the Google Health API have?

17 operations on 12 paths (8 GET, 7 POST, 1 PATCH, 1 DELETE). The largest groups are users.dataTypes.dataPoints, projects.subscribers.subscriptions, projects.subscribers, users.pairedDevices.

Is forking the Google Health API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.