Fetch

POST /api/fetch/{method}

Path parameters

method string Required

Can be one of the following: activeCaloriesBurned, basalBodyTemperature, basalMetabolicRate, bloodGlucose, bloodPressure, bodyFat, bodyTemperature, boneMass, cervicalMucus, distance, exerciseSession, elevationGained, floorsClimbed, heartRate, height, hydration, leanBodyMass, menstruationFlow, menstruationPeriod, nutrition, ovulationTest, oxygenSaturation, power, respiratoryRate, restingHeartRate, sleepSession, speed, steps, stepsCadence, totalCaloriesBurned, vo2Max, weight, wheelchairPushes

application/json

Body

userid string

The user id obtained from /api/login
queries array[string]

Queries to use to filter the data. See https://github.com/CoolCoderSJ/HCGateway#rest-api for more information.

Responses

200 application/json
Hide response attributes Show response attributes object
- $id string
  
  The id Health Connect stored the object with.
- $createdAt string(date-time)
- $updatedAt string(date-time)
- $permissions array[string]
- $databaseId string
- $collectionId string
- data object
  
  The actual data stored in Health Connect
- id string
- start string(date-time)
  
  The start time of the data
- end string(date-time) | null
  
  The end time of the data. Only present if the data is a time-series.
- app string
  
  The app that created the data

POST /api/fetch/{method}

curl \
 -X POST https://api.hcgateway.shuchir.dev/api/fetch/{method} \
 -H "Content-Type: application/json" \
 -d '{"userid":"string","queries":["string"]}'

Request examples

{
  "userid": "string",
  "queries": [
    "string"
  ]
}

Response examples (200)

{
  "$id": "string",
  "$createdAt": "2024-05-04T09:42:00+00:00",
  "$updatedAt": "2024-05-04T09:42:00+00:00",
  "$permissions": [
    "string"
  ],
  "$databaseId": "string",
  "$collectionId": "string",
  "data": {},
  "id": "string",
  "start": "2024-05-04T09:42:00+00:00",
  "end": "2024-05-04T09:42:00+00:00",
  "app": "string"
}