Measure v2 - Getworkouts
Returns workout summaries, which are an aggregation all data that was captured during that workout.
Use the Measure v2 - Getintradayactivity service to get the high frequency data used to build this summary.
Request
- Base URLhttps://wbsapi.withings.net
- Authnone declared. Required headers: Authorization
Query parameters
Service action name. Must take the string value getworkouts.
DO NOT USE WITH FOLLOWING PARAMS: [lastupdate]<br>Start date.
DO NOT USE WITH FOLLOWING PARAMS: [lastupdate]<br>End date. Required if startdateymd is provided.
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.
When a first call returns more:true and offset:XX, set value XX in this parameter to retrieve next available rows.
List of requested data fields, separated by a comma.<br>Available data fields are listed below.<br><u>Ex</u>: data_fields=calories,intensity,manual_intensity<br><br>calories<br>> Active calories burned (in Kcal). <br><br>intensity<br>> Intensity of the workout, from 0 to 100, as inputed by the user. If the user didn't manually give the intensity of his workout, the value will be 0.<br><br>manual_intensity<br>> Intensity of the workout, from 0 to 100, entered by the user. If the user didn't manually give the intensity of his workout, the value will be 0.<br><br>manual_distance<br>> Distance travelled manually entered by user (in meters). <br><br>manual_calories<br>> Active calories burned manually entered by user (in Kcal). <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>pause_duration<br>> Total pause time in second filled by user<br><br>algo_pause_duration<br>> Total pause time in seconds detected by Withings device (swim only)<br><br>spo2_average<br>> Average percent of SpO2 percent value during a workout<br><br>core_body_temperature_avg<br>> Average core body temperature (in celsius degrees). <br><br>core_body_temperature_min<br>> Minimal core body temperature (in celsius degrees). <br><br>core_body_temperature_max<br>> Maximal core body temperature (in celsius degrees). <br><br>core_body_temperature_status<br>> Status of the temperature. (Use 'data_fields' to request this data) Value can be: 'unknown', 'usual' or 'elevated'. <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>pool_laps<br>> Number of pool laps. <br><br>strokes<br>> Number of strokes. <br><br>pool_length<br>> Length of the pool. <br><br>
Headers
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)
Example response
{
"body": {
"series": [
{
"id": 12345,
"category": 36,
"timezone": "Europe/Paris",
"model": 59,
"startdate": 1594245600,
"enddate": 1594257200,
"date": "2020-07-09",
"modified": 1594257200,
"deviceid": "892359876fd8805ac45bab078c4828692f0276b1"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.