WIwithings
measure

Measure v2 - Getactivity

Provides daily aggregated activity data of a user.

posthttps://wbsapi.withings.net/v2/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 getactivity.

startdateymdstring required

DO NOT USE WITH FOLLOWING PARAMS: [lastupdate]<br>Start date.

enddateymdstring required

DO NOT USE WITH FOLLOWING PARAMS: [lastupdate]<br>End date.

lastupdateinteger required

DO NOT USE WITH FOLLOWING PARAMS: [startdateymd, enddateymd]<br>Timestamp for requesting data that were updated or created after this date.<br>Useful for data synchronization between systems.<br>Use this instead of startdateymd + enddateymd.

offsetinteger

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

data_fieldsstring

List of requested data fields, separated by a comma.<br>Available data fields are listed below.<br><u>Ex</u>: data_fields=steps,distance,elevation<br><br>steps<br>> Number of steps. <br><br>distance<br>> Distance travelled (in meters). <br><br>elevation<br>> Number of floors climbed. <br><br>soft<br>> Duration of soft activities (in seconds). <br><br>moderate<br>> Duration of moderate activities (in seconds). <br><br>intense<br>> Duration of intense activities (in seconds). <br><br>active<br>> Sum of intense and moderate activity durations (in seconds). <br><br>calories<br>> Active calories burned (in Kcal). Calculated by mixing fine granularity calories estimation, workouts estimated calories and calories manually set by the user. <br><br>totalcalories<br>> Total calories burned (in Kcal). Obtained by adding active calories (see calories) and passive calories.<br><br>hr_average<br>> Average heart rate. (beats per minute).<br><br>hr_min<br>> Minimal heart rate (beats per minute). <br><br>hr_max<br>> Maximal heart rate (beats per minute).. <br><br>hr_zone_0<br>> Duration in seconds when heart rate was in a light zone (cf. <a href='/api-reference/#section/Glossary'>Glossary</a>). <br><br>hr_zone_1<br>> Duration in seconds when heart rate was in a moderate zone (cf. <a href='/api-reference/#section/Glossary'>Glossary</a>). <br><br>hr_zone_2<br>> Duration in seconds when heart rate was in an intense zone (cf. <a href='/api-reference/#section/Glossary'>Glossary</a>). <br><br>hr_zone_3<br>> Duration in seconds when heart rate was in maximal zone (cf. <a href='/api-reference/#section/Glossary'>Glossary</a>). <br><br>

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": {
    "activities": [
      {
        "date": "2020-06-24",
        "timezone": "Europe/Paris",
        "deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
        "hash_deviceid": "892359876fd8805ac45bab078c4828692f0276b1",
        "brand": 18,
        "modified": 1594257200,
        "model": "Pulse HR",
        "modelid": 59,
        "steps": 6200,
        "distance": 3000,
        "elevation": 100,
        "soft": 800,
        "moderate": 1000,
        "intense": 700,
        "active": 2300,
        "calories": 1200,
        "totalcalories": 3500,
        "hr_average": 80,
        "hr_min": 70,
        "hr_max": 80,
        "hr_zone_0": 100,
        "hr_zone_1": 200,
        "hr_zone_2": 300,
        "hr_zone_3": 400
      }
    ]
  }
}

Changes

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