API reference
Provider Records
Retrieve user records
GET
Request
Response
Query Parameters
from
String
required
The start date of the query based on the user timezone; inclusive
provider
Array
optional
Allowed values:health_connect; fitbit; garmin; huawei; whoop; suunto; apple; oura; polar
timezone
String
optional
The timezone to use for responses, it would convert the internal timestamp from UTC to this timezone; if you leave empty it would use the user's timezone
Example: America/New_York
to
String
required
The end date of the query based on the user timezone; non-inclusive
Header Parameters
Authorization
String
required
Provide your bearer token in the Authorization header when making requests to protected resources.
Curl
1curl --request GET \
2 --url https://app-api.spikeapi.com/v3/queries/provider_records \
3 --header 'Accept: application/json, application/problem+json' \
4 --header 'Authorization: Bearer 123'
Responses
200
1{
2 "from": "2019-08-24T14:15:22Z",
3 "records": [
4 {
5 "activity_id": "string",
6 "activity_tags": [
7 "on_foot"
8 ],
9 "activity_type": "other",
10 "duration": 0,
11 "end_at_timestamp": "2019-08-24T14:15:22Z",
12 "entries": [
13 {
14 "division_ref": 0,
15 "division_type": "session",
16 "duration": 0,
17 "end_at": "2019-08-24T14:15:22Z",
18 "metrics": {
19 "air_temperature_avg": 123.45,
20 "air_temperature_max": 123.45,
21 "air_temperature_min": 123.45,
22 "ascent": 123.45,
23 "bedtime_duration": 123,
24 "body_mass_index": 123.4567,
25 "body_temperature": 123.45,
26 "cadence": 123.4567,
27 "cadence_avg": 123.4567,
28 "cadence_max": 123.4567,
29 "cadence_min": 123.4567,
30 "calories_burned": 123.4567,
31 "calories_burned_active": 123.4567,
32 "calories_burned_basal": 123.4567,
33 "calories_intake": 123.4567,
34 "descent": 123.45,
35 "distance": 123.4567,
36 "distance_cycling": 123.4567,
37 "distance_running": 123.4567,
38 "distance_swimming": 123.4567,
39 "distance_walking": 123.4567,
40 "distance_wheelchair": 123.4567,
41 "duration_active": 123,
42 "elevation": 123.45,
43 "elevation_avg": 123.45,
44 "elevation_gain": 123.45,
45 "elevation_loss": 123.45,
46 "elevation_max": 123.45,
47 "elevation_min": 123.45,
48 "floors_climbed": 123,
49 "heartrate": 123,
50 "heartrate_avg": 123,
51 "heartrate_max": 123,
52 "heartrate_min": 123,
53 "heartrate_resting": 123,
54 "height": 123.4567,
55 "hrv_rmssd": 123,
56 "hrv_sdnn": 123,
57 "latitude": 123.456789,
58 "longitude": 123.456789,
59 "pace_avg": 123.45,
60 "skin_temperature": 123.45,
61 "sleep_breathing_rate": 123.45,
62 "sleep_breathing_rate_avg": 123.45,
63 "sleep_breathing_rate_max": 123.45,
64 "sleep_breathing_rate_min": 123.45,
65 "sleep_duration": 123,
66 "sleep_duration_awake": 123,
67 "sleep_duration_deep": 123,
68 "sleep_duration_light": 123,
69 "sleep_duration_nap": 123,
70 "sleep_duration_rem": 123,
71 "sleep_efficiency": 123,
72 "sleep_interruptions": 123,
73 "sleep_latency": 123,
74 "sleep_score": 123,
75 "speed": 123.4567,
76 "speed_avg": 123.4567,
77 "speed_max": 123.4567,
78 "speed_min": 123.4567,
79 "spo2": 123.4567,
80 "spo2_avg": 123.4567,
81 "spo2_max": 123.4567,
82 "spo2_min": 123.4567,
83 "steps": 123,
84 "swimming_distance_per_stroke": 123.45,
85 "swimming_lengths": 123,
86 "vo2max": 123.45,
87 "wakeup_latency": 123,
88 "weight": 123.4567
89 },
90 "start_at": "2019-08-24T14:15:22Z"
91 }
92 ],
93 "input_method": "unknown",
94 "is_source_aggregated": true,
95 "metrics": {
96 "air_temperature_avg": 123.45,
97 "air_temperature_max": 123.45,
98 "air_temperature_min": 123.45,
99 "ascent": 123.45,
100 "bedtime_duration": 123,
101 "body_mass_index": 123.4567,
102 "body_temperature": 123.45,
103 "cadence": 123.4567,
104 "cadence_avg": 123.4567,
105 "cadence_max": 123.4567,
106 "cadence_min": 123.4567,
107 "calories_burned": 123.4567,
108 "calories_burned_active": 123.4567,
109 "calories_burned_basal": 123.4567,
110 "calories_intake": 123.4567,
111 "descent": 123.45,
112 "distance": 123.4567,
113 "distance_cycling": 123.4567,
114 "distance_running": 123.4567,
115 "distance_swimming": 123.4567,
116 "distance_walking": 123.4567,
117 "distance_wheelchair": 123.4567,
118 "duration_active": 123,
119 "elevation": 123.45,
120 "elevation_avg": 123.45,
121 "elevation_gain": 123.45,
122 "elevation_loss": 123.45,
123 "elevation_max": 123.45,
124 "elevation_min": 123.45,
125 "floors_climbed": 123,
126 "heartrate": 123,
127 "heartrate_avg": 123,
128 "heartrate_max": 123,
129 "heartrate_min": 123,
130 "heartrate_resting": 123,
131 "height": 123.4567,
132 "hrv_rmssd": 123,
133 "hrv_sdnn": 123,
134 "latitude": 123.456789,
135 "longitude": 123.456789,
136 "pace_avg": 123.45,
137 "skin_temperature": 123.45,
138 "sleep_breathing_rate": 123.45,
139 "sleep_breathing_rate_avg": 123.45,
140 "sleep_breathing_rate_max": 123.45,
141 "sleep_breathing_rate_min": 123.45,
142 "sleep_duration": 123,
143 "sleep_duration_awake": 123,
144 "sleep_duration_deep": 123,
145 "sleep_duration_light": 123,
146 "sleep_duration_nap": 123,
147 "sleep_duration_rem": 123,
148 "sleep_efficiency": 123,
149 "sleep_interruptions": 123,
150 "sleep_latency": 123,
151 "sleep_score": 123,
152 "speed": 123.4567,
153 "speed_avg": 123.4567,
154 "speed_max": 123.4567,
155 "speed_min": 123.4567,
156 "spo2": 123.4567,
157 "spo2_avg": 123.4567,
158 "spo2_max": 123.4567,
159 "spo2_min": 123.4567,
160 "steps": 123,
161 "swimming_distance_per_stroke": 123.45,
162 "swimming_lengths": 123,
163 "vo2max": 123.45,
164 "wakeup_latency": 123,
165 "weight": 123.4567
166 },
167 "modified_at": "2019-08-24T14:15:22Z",
168 "provider_slug": "fitbit",
169 "provider_source": "fitbit",
170 "provider_source_type": "provider_summary",
171 "record_id": "34e5506a-c8b9-4e24-8937-25ad88b450c0",
172 "source": {
173 "device_manufacturer": "string",
174 "device_model": "string",
175 "device_product": "string",
176 "device_version": "string",
177 "source_bundle_identifier": "string",
178 "source_os_version": "string",
179 "source_product": "string",
180 "source_version": "string"
181 },
182 "start_at_timestamp": "2019-08-24T14:15:22Z",
183 "user_time_offset_minutes": 0
184 }
185 ],
186 "timezone": "string",
187 "to": "2019-08-24T14:15:22Z"
188}