data

Return Apple Healthkit Workout data

Retrieve the Apple workouts that occurred for the user during the specified period of time.

get/data/v0/{fulcra_userid}/apple_workouts

Request

  • Base URL: https://api.fulcradynamics.com
  • URL: https://api.fulcradynamics.com/data/v0/{fulcra_userid}/apple_workouts
  • Auth: HTTP bearer

Path parameters

fulcra_useridstring uuid required

Query parameters

start_timestring date-time required

The starting timestamp in ISO 8601 format (inclusive)

Example:2023-02-01 00:00:00Z
end_timestring date-time required

The ending timestamp in ISO 8601 format (exclusive)

Example:2023-02-03 00:00:00Z

Response

Successful Response

all_statisticsobject required

A collection of descriptive statistics for the workout.

apple_workout_idstring uuid required

Workout ID

deviceobject nullable required

Details of the device that recorded the workout,

durationnumber required

Length of the workout (seconds)

end_datestring date-time required

the date/time when this workout ends

extrasobject nullable required

Extra values that are not (yet) accounted for in the schema.

has_undetermined_durationboolean required

indicates whether or not this workout has an unknown duration

source_revisionobject required
    Details of the source application or device that recorded the workout.
start_datestring date-time required

the date/time when this workout starts

workout_activitiesobject[] required

An ordered list of time segments that describe the workout.

workout_activity_typestring
workout_eventsobject[] required

An ordered list of events that occurred during the workout.

Changes

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