Integrating with SpikeAPI
API Reference: User Management
API Reference: Querying Data
Types and Definitions
Release Notes
API Reference: Querying Data
List Provider Records
List Provider Records
Query provider records with metrics, optionally filtering by providers.
This endpoint allows you to query provider records with support for:
- Filtering by UTC timestamp range and providers.
- Including provider-specific metrics in the response.
The response includes records with raw data from providers transformed into the unified data model, each possibly including:
- base information (start, end, duration, user time offset, input method, source provider, etc.)
- metrics (base and provider-specific)
- activity information such as activity ID, type, and tags
- activity breakdown into laps, sessions, etc.
- sleeps with sample data
All timestamps in both request and response are in the UTC timezone.
Copy
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/provider_records \
--header 'Authorization: Bearer <token>'
Copy
{
"from_timestamp": "2006-01-02T00:00:00Z",
"records": [
{
"activity_id": "<string>",
"activity_tags": [
"on_foot"
],
"activity_type": "other",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"input_method": "unknown",
"is_source_aggregated": true,
"metrics": {
"air_temperature": 123.45,
"air_temperature_max": 123.45,
"air_temperature_min": 123.45,
"ascent": 123.45,
"basal_body_temperature": 123.45,
"basal_body_temperature_max": 123.45,
"basal_body_temperature_min": 123.45,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123.45,
"blood_pressure_diastolic_max": 123.45,
"blood_pressure_diastolic_min": 123.45,
"blood_pressure_systolic": 123.45,
"blood_pressure_systolic_max": 123.45,
"blood_pressure_systolic_min": 123.45,
"body_bone_mass": 123,
"body_fat": 123.45,
"body_fat_max": 123.45,
"body_fat_min": 123.45,
"body_mass_index": 123.4567,
"body_temperature": 123.45,
"body_temperature_max": 123.45,
"body_temperature_min": 123.45,
"breathing_rate": 123.4567,
"breathing_rate_max": 123.4567,
"breathing_rate_min": 123.4567,
"cadence": 123.4567,
"cadence_max": 123.4567,
"cadence_min": 123.4567,
"calories_burned": 123.4567,
"calories_burned_active": 123.4567,
"calories_burned_basal": 123.4567,
"calories_intake": 123.4567,
"descent": 123.45,
"distance": 123.4567,
"distance_cycling": 123.4567,
"distance_running": 123.4567,
"distance_swimming": 123.4567,
"distance_walking": 123.4567,
"distance_wheelchair": 123.4567,
"duration_active": 123,
"ecg_rri": 123,
"ecg_voltage": 123.45,
"elevation": 123.45,
"elevation_gain": 123.45,
"elevation_loss": 123.45,
"elevation_max": 123.45,
"elevation_min": 123.45,
"floors_climbed": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"height": 123.4567,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123.456789,
"longitude": 123.456789,
"pace": 123.45,
"skin_temperature": 123.45,
"skin_temperature_max": 123.45,
"skin_temperature_min": 123.45,
"sleep_breathing_rate": 123.45,
"sleep_breathing_rate_max": 123.45,
"sleep_breathing_rate_min": 123.45,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"speed": 123.4567,
"speed_max": 123.4567,
"speed_min": 123.4567,
"spo2": 123.4567,
"spo2_max": 123.4567,
"spo2_min": 123.4567,
"steps": 123,
"swimming_distance_per_stroke": 123.45,
"swimming_lengths": 123,
"vo2max": 123.45,
"wakeup_latency": 123,
"weight": 123.4567
},
"modified_at": "2023-11-07T05:31:56Z",
"provider_local_date": "2006-01-02",
"provider_slug": "strava",
"provider_source": "apple_healthkit_sample",
"provider_source_type": "provider_summary",
"provider_specific_metrics": {
"garmin": {
"overall_sleep_score_qualifier_key": "<string>",
"overall_sleep_score_value": 123,
"time_offset_stress_level_values": "<string>"
},
"huawei": {
"sleep_score": 123
},
"oura": {
"sleep_score": 123
},
"polar": {
"sleep_score": 123
},
"suunto": {
"sleep_quality_score": 123
},
"whoop": {
"sleep_consistency_percentage": 123,
"sleep_performance_percentage": 123
},
"withings": {
"sleep_score": 123
}
},
"record_id": "40c99984-196b-49af-8bcf-0f54c2b4c5ea",
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"start_at_timestamp": "2023-11-07T05:31:56Z",
"user_time_offset_minutes": 123
}
],
"to_timestamp": "2006-01-02T00:00:00Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Start time of the query range in UTC
Examples:
"2006-01-02T15:04:05"
"2006-01-02T15:04:05Z"
End time of the query range in UTC
Examples:
"2006-01-02T15:04:05"
"2006-01-02T15:04:05Z"
Provider slugs
Include metrics
Show child attributes
Show child attributes
Include provider specific metrics such as unique sleep score
Response
200
application/json
OK
The response is of type object
.
Previous
Get Provider Record### Query a Provider Record by ID
Query a single provider record with metrics by ID.
This endpoint allows you to query for the provider record with support for:
- Including sample data based on time series in the response.
- Including provider-specific metrics in the response.
The response includes a single record with raw data from the provider transformed into the unified data model, possibly including:
- base information (start, end, duration, user time offset, input method, source provider, etc.)
- metrics (base and provider-specific)
- activity information such as activity ID, type, and tags
- activity breakdown into laps, sessions, etc. with related sample data
- sleep with sample data
All timestamps in the response are in the UTC timezone.
Next
Copy
curl --request GET \
--url https://app-api.spikeapi.com/v3/queries/provider_records \
--header 'Authorization: Bearer <token>'
Copy
{
"from_timestamp": "2006-01-02T00:00:00Z",
"records": [
{
"activity_id": "<string>",
"activity_tags": [
"on_foot"
],
"activity_type": "other",
"duration": 123,
"end_at_timestamp": "2023-11-07T05:31:56Z",
"input_method": "unknown",
"is_source_aggregated": true,
"metrics": {
"air_temperature": 123.45,
"air_temperature_max": 123.45,
"air_temperature_min": 123.45,
"ascent": 123.45,
"basal_body_temperature": 123.45,
"basal_body_temperature_max": 123.45,
"basal_body_temperature_min": 123.45,
"bedtime_duration": 123,
"blood_pressure_diastolic": 123.45,
"blood_pressure_diastolic_max": 123.45,
"blood_pressure_diastolic_min": 123.45,
"blood_pressure_systolic": 123.45,
"blood_pressure_systolic_max": 123.45,
"blood_pressure_systolic_min": 123.45,
"body_bone_mass": 123,
"body_fat": 123.45,
"body_fat_max": 123.45,
"body_fat_min": 123.45,
"body_mass_index": 123.4567,
"body_temperature": 123.45,
"body_temperature_max": 123.45,
"body_temperature_min": 123.45,
"breathing_rate": 123.4567,
"breathing_rate_max": 123.4567,
"breathing_rate_min": 123.4567,
"cadence": 123.4567,
"cadence_max": 123.4567,
"cadence_min": 123.4567,
"calories_burned": 123.4567,
"calories_burned_active": 123.4567,
"calories_burned_basal": 123.4567,
"calories_intake": 123.4567,
"descent": 123.45,
"distance": 123.4567,
"distance_cycling": 123.4567,
"distance_running": 123.4567,
"distance_swimming": 123.4567,
"distance_walking": 123.4567,
"distance_wheelchair": 123.4567,
"duration_active": 123,
"ecg_rri": 123,
"ecg_voltage": 123.45,
"elevation": 123.45,
"elevation_gain": 123.45,
"elevation_loss": 123.45,
"elevation_max": 123.45,
"elevation_min": 123.45,
"floors_climbed": 123,
"heartrate": 123,
"heartrate_max": 123,
"heartrate_min": 123,
"heartrate_resting": 123,
"heartrate_resting_max": 123,
"heartrate_resting_min": 123,
"height": 123.4567,
"hrv_rmssd": 123,
"hrv_sdnn": 123,
"latitude": 123.456789,
"longitude": 123.456789,
"pace": 123.45,
"skin_temperature": 123.45,
"skin_temperature_max": 123.45,
"skin_temperature_min": 123.45,
"sleep_breathing_rate": 123.45,
"sleep_breathing_rate_max": 123.45,
"sleep_breathing_rate_min": 123.45,
"sleep_duration": 123,
"sleep_duration_awake": 123,
"sleep_duration_deep": 123,
"sleep_duration_light": 123,
"sleep_duration_nap": 123,
"sleep_duration_rem": 123,
"sleep_efficiency": 123,
"sleep_interruptions": 123,
"sleep_latency": 123,
"sleep_score": 123,
"speed": 123.4567,
"speed_max": 123.4567,
"speed_min": 123.4567,
"spo2": 123.4567,
"spo2_max": 123.4567,
"spo2_min": 123.4567,
"steps": 123,
"swimming_distance_per_stroke": 123.45,
"swimming_lengths": 123,
"vo2max": 123.45,
"wakeup_latency": 123,
"weight": 123.4567
},
"modified_at": "2023-11-07T05:31:56Z",
"provider_local_date": "2006-01-02",
"provider_slug": "strava",
"provider_source": "apple_healthkit_sample",
"provider_source_type": "provider_summary",
"provider_specific_metrics": {
"garmin": {
"overall_sleep_score_qualifier_key": "<string>",
"overall_sleep_score_value": 123,
"time_offset_stress_level_values": "<string>"
},
"huawei": {
"sleep_score": 123
},
"oura": {
"sleep_score": 123
},
"polar": {
"sleep_score": 123
},
"suunto": {
"sleep_quality_score": 123
},
"whoop": {
"sleep_consistency_percentage": 123,
"sleep_performance_percentage": 123
},
"withings": {
"sleep_score": 123
}
},
"record_id": "40c99984-196b-49af-8bcf-0f54c2b4c5ea",
"samples": {
"durations": [
123
],
"offsets": [
123
],
"values": {
"air_temperature": [
123
],
"air_temperature_max": [
123
],
"air_temperature_min": [
123
],
"ascent": [
123
],
"basal_body_temperature": [
123
],
"basal_body_temperature_max": [
123
],
"basal_body_temperature_min": [
123
],
"bedtime_duration": [
123
],
"blood_pressure_diastolic": [
123
],
"blood_pressure_diastolic_max": [
123
],
"blood_pressure_diastolic_min": [
123
],
"blood_pressure_systolic": [
123
],
"blood_pressure_systolic_max": [
123
],
"blood_pressure_systolic_min": [
123
],
"body_bone_mass": [
123
],
"body_fat": [
123
],
"body_fat_max": [
123
],
"body_fat_min": [
123
],
"body_mass_index": [
123
],
"body_temperature": [
123
],
"body_temperature_max": [
123
],
"body_temperature_min": [
123
],
"breathing_rate": [
123
],
"breathing_rate_max": [
123
],
"breathing_rate_min": [
123
],
"cadence": [
123
],
"cadence_max": [
123
],
"cadence_min": [
123
],
"calories_burned": [
123
],
"calories_burned_active": [
123
],
"calories_burned_basal": [
123
],
"calories_intake": [
123
],
"descent": [
123
],
"distance": [
123
],
"distance_cycling": [
123
],
"distance_running": [
123
],
"distance_swimming": [
123
],
"distance_walking": [
123
],
"distance_wheelchair": [
123
],
"duration_active": [
123
],
"ecg_rri": [
123
],
"ecg_voltage": [
123
],
"elevation": [
123
],
"elevation_gain": [
123
],
"elevation_loss": [
123
],
"elevation_max": [
123
],
"elevation_min": [
123
],
"floors_climbed": [
123
],
"heartrate": [
123
],
"heartrate_max": [
123
],
"heartrate_min": [
123
],
"heartrate_resting": [
123
],
"heartrate_resting_max": [
123
],
"heartrate_resting_min": [
123
],
"height": [
123
],
"hrv_rmssd": [
123
],
"hrv_sdnn": [
123
],
"latitude": [
123
],
"longitude": [
123
],
"pace": [
123
],
"skin_temperature": [
123
],
"skin_temperature_max": [
123
],
"skin_temperature_min": [
123
],
"sleep_breathing_rate": [
123
],
"sleep_breathing_rate_max": [
123
],
"sleep_breathing_rate_min": [
123
],
"sleep_duration": [
123
],
"sleep_duration_awake": [
123
],
"sleep_duration_deep": [
123
],
"sleep_duration_light": [
123
],
"sleep_duration_nap": [
123
],
"sleep_duration_rem": [
123
],
"sleep_efficiency": [
123
],
"sleep_interruptions": [
123
],
"sleep_latency": [
123
],
"sleep_score": [
123
],
"speed": [
123
],
"speed_max": [
123
],
"speed_min": [
123
],
"spo2": [
123
],
"spo2_max": [
123
],
"spo2_min": [
123
],
"steps": [
123
],
"swimming_distance_per_stroke": [
123
],
"swimming_lengths": [
123
],
"vo2max": [
123
],
"wakeup_latency": [
123
],
"weight": [
123
]
}
},
"source": {
"device_manufacturer": "<string>",
"device_model": "<string>",
"device_product": "<string>",
"device_version": "<string>",
"source_bundle_identifier": "<string>",
"source_os_version": "<string>",
"source_product": "<string>",
"source_version": "<string>"
},
"start_at_timestamp": "2023-11-07T05:31:56Z",
"user_time_offset_minutes": 123
}
],
"to_timestamp": "2006-01-02T00:00:00Z"
}
Assistant
Responses are generated using AI and may contain mistakes.