Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Measurements associated with a user’s weight and body mass.

Weight URLS

  • GET /v1/organizations/:organization_id/weight

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

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

Weight Short URLS

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

  • GET /v1/weight(.:format)

Parameters

The following section displays the parameters​ used to retrieve data

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/weight.json \
     --header 'Validic-Version: 2016-03-01' \
     --header 'accept: application/json'

Response

{
  "summary": {
    "status": 200,
    "message": "Ok",
    "results": 5110,
    "start_date": "2015-10-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/weight/latest?access_token=9ff1217aSAMPLE689a3e2fce700de97387920bfaabddc871604a277cb901b2&end_date=2015-12-03T08%3A54%3A27Z&expanded=0&limit=200&page=2&start_date=2015-10-01T08%3A44%3A29Z",
    "params": {
      "start_date": "2015-10-01T08:44:29+00:00",
      "end_date": "2015-12-03T08:54:27+00:00",
      "offset": 0,
      "limit": 200
    }
  },
  "weight": [
    {
      "_id": "565ffed9418SAMPLEe0622bf",
      "bmi": 18.5,
      "fat_percent": null,
      "free_mass": null,
      "height": null,
      "last_updated": "2015-12-03T08:35:37+00:00",
      "mass_weight": null,
      "source": "fitbit",
      "source_name": "Fitbit",
      "timestamp": "2014-03-12T22:59:59+00:00",
      "user_id": "565ec4dc624c26SAMPLE000c",
      "utc_offset": "+01:00",
      "validated": false,
      "weight": 56
    },
    {
      "_id": "565febb8663SAMPLEb05c2e7",
      "bmi": 22.77,
      "fat_percent": null,
      "free_mass": null,
      "height": null,
      "last_updated": "2015-12-03T07:14:00+00:00",
      "mass_weight": null,
      "source": "fitbit",
      "source_name": "Fitbit",
      "timestamp": "2015-12-03T22:59:59+00:00",
      "user_id": "55ef247fe813SAMPLE0013",
      "utc_offset": "+01:00",
      "validated": false,
      "weight": 70.5
    }
  ]
}

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

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)

weight

Double

The value of the measured quantity in kg

height

Double

The value of the measured quantity in cm

free_mass

Double

The value of the measured quantity in kg

fat_percent

Double

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

mass_weight

Double

The value of the measured quantity in kg

bmi

The value of the measured quantity

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}/weight.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

GET https://api.validic.com/v1/weight.json?authentication_token={USER_ACCESS_TOKEN}&source={SOURCE}

Start Date of Activity

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/weight.json?access_token={ORGANIZATION_ACCESS_TOKEN}&start_date=2014-03-10T00:00:00+00:00

  • No labels