Biometrics

GET: https://api.validic.com/v1/organizations/{organization_id}/users/{user_id}/biometrics.json

Biometric Measurements comprise a user’s biometric health data such as blood pressure, cholesterol, heart rate, and blood and hormone levels.

Biometric URLS

  • GET /v1/organizations/:organization_id/biometrics

  • GET /v1/organizations/:organization_id/biometrics/latest

  • GET /v1/organizations/:organization_id/users/:user_id/biometrics

  • GET /v1/organizations/:organization_id/users/:user_id/biometrics/latest

Biometric Short URLs

  • GET /v1/biometrics/latest(.:format)

  • GET /v1/biometrics(.:format)

Parameters

The following section displays the parameters​ used to retrieve data.

Request

curl --request GET \ --url https://api.validic.com/v1/organizations/organization_id/users/user_id/biometrics.json \ --header 'Validic-Version: 2016-03-01' \ --header 'accept: application/json'

Response

{ "summary": { "status": 200, "message": "Ok", "results": 1900, "start_date": "2015-09-01T08:44:29+00:00", "end_date": "2015-12-03T08:54:27+00:00", "offset": 0, "limit": 200, "previous": null, "next": "https://api.validic.com/v1/organizations/5400864SAMPLEd683000004/biometrics/latest?access_token=9ff1217aSAMPLE689a3e2fce700de97387920bfaabddc871604a277cb901b2&end_date=2015-12-03T08%3A54%3A27Z&expanded=0&limit=200&page=2&start_date=2015-09-01T08%3A44%3A29Z", "params": { "start_date": "2015-09-01T08:44:29+00:00", "end_date": "2015-12-03T08:54:27+00:00", "offset": 0, "limit": 200 } }, "biometrics": [ { "_id": "564e0acd3eSAMPLE79000167", "blood_calcium": null, "blood_chromium": null, "blood_folic_acid": null, "blood_magnesium": null, "blood_potassium": null, "blood_sodium": null, "blood_vitamin_b12": null, "blood_zinc": null, "creatine_kinase": null, "crp": null, "diastolic": 96, "ferritin": null, "hdl": null, "hscrp": null, "il6": null, "last_updated": "2015-11-19T17:45:49+00:00", "ldl": null, "resting_heartrate": 75, "source": "ihealth", "source_name": "iHealth", "spo2": null, "systolic": 133, "temperature": null, "testosterone": null, "timestamp": "2015-11-19T17:45:47+00:00", "total_cholesterol": null, "tsh": null, "uric_acid": null, "user_id": "54b82ab898b4b1SAMPLE0009b", "utc_offset": "-05:00", "validated": true, "vitamin_d": null, "white_cell_count": null }, { "_id": "564e07e03e2acSAMPLE00164", "blood_calcium": null, "blood_chromium": null, "blood_folic_acid": null, "blood_magnesium": null, "blood_potassium": null, "blood_sodium": null, "blood_vitamin_b12": null, "blood_zinc": null, "creatine_kinase": null, "crp": null, "diastolic": 85, "ferritin": null, "hdl": null, "hscrp": null, "il6": null, "last_updated": "2015-11-19T17:33:20+00:00", "ldl": null, "resting_heartrate": 69, "source": "ihealth", "source_name": "iHealth", "spo2": null, "systolic": 123, "temperature": null, "testosterone": null, "timestamp": "2015-11-19T17:33:15+00:00", "total_cholesterol": null, "tsh": null, "uric_acid": null, "user_id": "54b82ab898b4bSAMPLE00009b", "utc_offset": "-05:00", "validated": true, "vitamin_d": null, "white_cell_count": null } ] }

Return Values

The following values are included in a standard response. Expanded data varies by source. You can locate a complete list of expanded fields here.

Return Value

Type

Description

Return Value

Type

Description

timestamp

String

Timestamp for the measurement set

utc_offset

String

Timezone information for the measurement set

source

String

The short name of the application that recorded the activity

source_name

String

The display name of the application that recorded the activity

last_updated

String

Date and time when the measurement set was last updated

_id

String

Unique identifier of the activity (required for POST requests)

blood_calcium

Double

The value of the measured quantity in mg/dL

blood_chromium

Double

The value of the measured quantity in µg/L

blood_folic_acid

Double

The value of the measured quantity in ng/mL

blood_magnesium

Double

The value of the measured quantity in mg/dL

blood_potassium

Double

The value of the measured quantity in mEq/L

blood_sodium

Double

The value of the measured quantity in mEq/L

blood_vitamin_b12

Double

The value of the measured quantity in pg/mL

blood_zinc

Double

The value of the measured quantity in µg/dL

creatine_kinase

Double

The value of the measured quantity in U/L

crp

Double

The value of the measured quantity in mg/L

diastolic

Double

The value of the measured quantity in mmHg

ferritin

Double

The value of the measured quantity in ng/mL

hdl

Double

The value of the measured quantity in mg/dL

hscrp

Double

The value of the measured quantity in mg/L

il6

Double

The value of the measured quantity in pg/mL

ldl

Double

The value of the measured quantity in mg/dL

resting_heartrate

Double

The value of the measured quantity in bpm

systolic

Double

The value of the measured quantity in mmHg

testosterone

Double

The value of the measured quantity in ng/dL

total_cholesterol

Double

The value of the measured quantity in mg/dL

tsh

Double

The value of the measured quantity in mIU/L

uric_acid

Double

The value of the measured quantity in mg/dL

vitamin_d

Double

The value of the measured quantity in ng/mL

white_cell_count

Double

The value of the measured quantity in cells/µL

spo2

Double

The value of the measured quantity (0 - 100%)

temperature

Double

The value of the measured quantity in Celsius

validated

Boolean

Value indicates the data you are receiving was generated using a device, opposed to being manually entered by an end user

Additional Examples

Filter by date and expanded

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/users/{USER_ID}/biometrics.json?access_token={ORGANIZATION_ACCESS_TOKEN}&start_date=2015-09-01T00:00:00+00:00&end_date=2015-09-30T23:59:59+00:00&expanded=1

Filter by Source

Start Date of Activity