Health API (Beta)

post /health

Submit health data

Base URL https://api.vseepreview.com/api_v3 · operationId submitHealthData

Authentication: User Token — Requires a user access token from login or SSO.

Submit health measurement data from a registered device

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-ApiKeyheaderstringyesAPI Key (e.g. your_api_key)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)

Request body

Content type: application/json

FieldTypeRequiredEnumDescription
typestringyesDevice type
datestringyesDate in YYYY-MM-DD format
timeintegeryesUNIX timestamp
device_idstringyesDevice unique identifier
data_typestringyestemperature_body, bg, bp, weight, active_minutes, steps, hr, bo, illuminance, humidity, gas, movement, noise, rangeType of measurement
data_classstringyesbody, environmentData classification
temperature_bodystringnoBody temperature value
temperature_unitstringnocel, fahTemperature unit
bgnumbernoBlood glucose value
bg_unitstringnomg/dL, mmol/LBlood glucose unit
hpintegernoSystolic blood pressure (high pressure)
lpintegernoDiastolic blood pressure (low pressure)
bp_unitstringnommHg, kPaBlood pressure unit
weightnumbernoWeight value
weight_unitstringnolbs, kgWeight unit
active_minutesintegernoActive minutes
stepsintegernoStep count
hrnumbernoHeart rate
bonumbernoBlood oxygen
illuminancenumbernoIlluminance value
illuminance_unitstringnoluxIlluminance unit
humiditynumbernoHumidity value
humidity_unitstringnopercentageHumidity unit
gasstringnoGas value
movementnoMovement value
noisenumbernoNoise level
noise_unitstringno
rangenumbernoRange in cm
range_unitstringnocmRange unit

Example:

{
  "type": "ihealth_thermometer_pt3sbt",
  "date": "2021-08-25",
  "time": 1695626540,
  "device_id": "004D320DCAA2",
  "data_type": "temperature_body",
  "data_class": "body",
  "temperature_body": "36.76",
  "temperature_unit": "cel"
}

Responses

200 — Health data submitted successfully

{
  "data": {
    "id": "string",
    "status": "string"
  }
}

Machine-readable: OpenAPI JSON (operationId: submitHealthData)