measure

Measure - Getmeas

Provides measures stored at a specific date among the types below. Please refer to the following responses for details.

posthttps://wbsapi.withings.net/measure

Request

  • Base URL
    https://wbsapi.withings.net
  • Auth
    none declared. Required headers: Authorization

Query parameters

actionstring required

Service action name. Must take the string value getmeas.

signaturestring

Hash of params (Cf. Signature hash protocol).

meastypeinteger

Requested measure type :

ValueDescription
1Weight (kg)
4Height (meter)
5Fat Free Mass (kg)
6Fat Ratio (%)
8Fat Mass Weight (kg)
9Diastolic Blood Pressure (mmHg)
10Systolic Blood Pressure (mmHg)
11Heart Pulse (bpm) - only for BPM and scale devices
12Temperature (celsius)
54SP02 (%)
71Body Temperature (celsius)
73Skin Temperature (celsius)
76Muscle Mass (kg)
77Hydration (kg)
88Bone Mass (kg)
91Pulse Wave Velocity (m/s)
123VO2 max is a numerical measurement of your body’s ability to consume oxygen (ml/min/kg).
130Atrial fibrillation result
135QRS interval duration based on ECG signal
136PR interval duration based on ECG signal
137QT interval duration based on ECG signal
138Corrected QT interval duration based on ECG signal
139Atrial fibrillation result from PPG
147Urinary pH
148Urine Specific Gravity
151Urinary Nitrites (µmol/L)
155Vascular age
167Nerve Health Score Conductance 2 electrodes Feet
168Extracellular Water in kg
169Intracellular Water in kg
170Visceral Fat (without unity)
173Fat Free Mass for segments
174Fat Mass for segments in mass unit
175Muscle Mass for segments
196Nerve Response Score (NRS)
204Urinary Ketones (mmol/L)
205Urinary Vitamin C (mmol/L)
226Basal Metabolic Rate (BMR)
227Metabolic Age
229Electrochemical Skin Conductance (ESC)
248Urinary Calcium (mmol/L)
249Urinary Creatinine (mmol/L)
251Urinary Calcium/Creatinine Ratio (mmol/mmol)
meastypesunknown

List of requested measure types (separated by a comma).<br>Ex: meastypes=1,4,12

categoryinteger

1 for real measures, 2 for user objectives.

startdateinteger

Data start date as a unix timestamp.

enddateinteger

Data end date as a unix timestamp.

lastupdateinteger

Timestamp for requesting data that were updated or created after this date.<br>Useful for data synchronization between systems.<br>Use this instead of startdate + enddate.

offsetinteger

When a first call returns more:1 and offset:XX, set value XX in this parameter to retrieve next available rows.

Headers

Authorizationstring required

Used to pass your access token. Must take value: Bearer {your access_token} Replace {your access_token} with the access_token

Response

(Click to unfold)

statusinteger

Response status. See <a href='#tag/response_status'>Status</a> section for details.

Example response

{
  "body": {
    "measuregrps": [
      {
        "grpid": 12,
        "attrib": 1,
        "date": 1594245600,
        "created": 1594246600,
        "modified": 1594257200,
        "category": 1594257200,
        "deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
        "hash_deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
        "measures": [
          {
            "value": 65750,
            "type": 1,
            "unit": -3,
            "algo": 3425,
            "position": 1
          }
        ],
        "model": "Body Cardio",
        "model_id": 6,
        "comment": "A measurement comment"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.