API reference
Provider Records
{ "name" "get user provider records", "method" "get", "url" "https //app api spikeapi com/v3/queries/provider records", "description" "retrieve user records", "tab" "examples", "examples" { "languages" \[ { "id" "co nququth xyjnpwxess", "language" "curl", "code" "curl request get \\\\\n url https //app api spikeapi com/v3/queries/provider records \\\\\n header 'accept application/json, application/problem+json' \\\\\n header 'authorization bearer eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9 eyjpc3mioii5otk5osisinn1yii6ime5zju3odazmgixythkywuifq djhtpuc7gakk03rtfqxufjzrbnpfwjgvjnfu7yuy4a4'", "customlabel" "" } ], "selectedlanguageid" "co nququth xyjnpwxess" }, "results" { "languages" \[ { "id" "qfu6epz 8pp15gg8ebsdx", "language" "200", "code" "{\n \\"from\\" \\"2019 08 24t14 15 22z\\",\n \\"records\\" \[\n {\n \\"activity id\\" \\"string\\",\n \\"activity tags\\" \[\n \\"on foot\\"\n ],\n \\"activity type\\" \\"other\\",\n \\"duration\\" 0,\n \\"end at timestamp\\" \\"2019 08 24t14 15 22z\\",\n \\"entries\\" \[\n {\n \\"division ref\\" 0,\n \\"division type\\" \\"session\\",\n \\"duration\\" 0,\n \\"end at\\" \\"2019 08 24t14 15 22z\\",\n \\"metrics\\" {\n \\"air temperature avg\\" 123 45,\n \\"air temperature max\\" 123 45,\n \\"air temperature min\\" 123 45,\n \\"ascent\\" 123 45,\n \\"bedtime duration\\" 123,\n \\"body mass index\\" 123 4567,\n \\"body temperature\\" 123 45,\n \\"cadence\\" 123 4567,\n \\"cadence avg\\" 123 4567,\n \\"cadence max\\" 123 4567,\n \\"cadence min\\" 123 4567,\n \\"calories burned\\" 123 4567,\n \\"calories burned active\\" 123 4567,\n \\"calories burned basal\\" 123 4567,\n \\"calories intake\\" 123 4567,\n \\"descent\\" 123 45,\n \\"distance\\" 123 4567,\n \\"distance cycling\\" 123 4567,\n \\"distance running\\" 123 4567,\n \\"distance swimming\\" 123 4567,\n \\"distance walking\\" 123 4567,\n \\"distance wheelchair\\" 123 4567,\n \\"duration active\\" 123,\n \\"elevation\\" 123 45,\n \\"elevation avg\\" 123 45,\n \\"elevation gain\\" 123 45,\n \\"elevation loss\\" 123 45,\n \\"elevation max\\" 123 45,\n \\"elevation min\\" 123 45,\n \\"floors climbed\\" 123,\n \\"heartrate\\" 123,\n \\"heartrate avg\\" 123,\n \\"heartrate max\\" 123,\n \\"heartrate min\\" 123,\n \\"heartrate resting\\" 123,\n \\"height\\" 123 4567,\n \\"hrv rmssd\\" 123,\n \\"hrv sdnn\\" 123,\n \\"latitude\\" 123 456789,\n \\"longitude\\" 123 456789,\n \\"pace avg\\" 123 45,\n \\"skin temperature\\" 123 45,\n \\"sleep breathing rate\\" 123 45,\n \\"sleep breathing rate avg\\" 123 45,\n \\"sleep breathing rate max\\" 123 45,\n \\"sleep breathing rate min\\" 123 45,\n \\"sleep duration\\" 123,\n \\"sleep duration awake\\" 123,\n \\"sleep duration deep\\" 123,\n \\"sleep duration light\\" 123,\n \\"sleep duration nap\\" 123,\n \\"sleep duration rem\\" 123,\n \\"sleep efficiency\\" 123,\n \\"sleep interruptions\\" 123,\n \\"sleep latency\\" 123,\n \\"sleep score\\" 123,\n \\"speed\\" 123 4567,\n \\"speed avg\\" 123 4567,\n \\"speed max\\" 123 4567,\n \\"speed min\\" 123 4567,\n \\"spo2\\" 123 4567,\n \\"spo2 avg\\" 123 4567,\n \\"spo2 max\\" 123 4567,\n \\"spo2 min\\" 123 4567,\n \\"steps\\" 123,\n \\"swimming distance per stroke\\" 123 45,\n \\"swimming lengths\\" 123,\n \\"vo2max\\" 123 45,\n \\"wakeup latency\\" 123,\n \\"weight\\" 123 4567\n },\n \\"start at\\" \\"2019 08 24t14 15 22z\\"\n }\n ],\n \\"input method\\" \\"unknown\\",\n \\"is source aggregated\\" true,\n \\"metrics\\" {\n \\"air temperature avg\\" 123 45,\n \\"air temperature max\\" 123 45,\n \\"air temperature min\\" 123 45,\n \\"ascent\\" 123 45,\n \\"bedtime duration\\" 123,\n \\"body mass index\\" 123 4567,\n \\"body temperature\\" 123 45,\n \\"cadence\\" 123 4567,\n \\"cadence avg\\" 123 4567,\n \\"cadence max\\" 123 4567,\n \\"cadence min\\" 123 4567,\n \\"calories burned\\" 123 4567,\n \\"calories burned active\\" 123 4567,\n \\"calories burned basal\\" 123 4567,\n \\"calories intake\\" 123 4567,\n \\"descent\\" 123 45,\n \\"distance\\" 123 4567,\n \\"distance cycling\\" 123 4567,\n \\"distance running\\" 123 4567,\n \\"distance swimming\\" 123 4567,\n \\"distance walking\\" 123 4567,\n \\"distance wheelchair\\" 123 4567,\n \\"duration active\\" 123,\n \\"elevation\\" 123 45,\n \\"elevation avg\\" 123 45,\n \\"elevation gain\\" 123 45,\n \\"elevation loss\\" 123 45,\n \\"elevation max\\" 123 45,\n \\"elevation min\\" 123 45,\n \\"floors climbed\\" 123,\n \\"heartrate\\" 123,\n \\"heartrate avg\\" 123,\n \\"heartrate max\\" 123,\n \\"heartrate min\\" 123,\n \\"heartrate resting\\" 123,\n \\"height\\" 123 4567,\n \\"hrv rmssd\\" 123,\n \\"hrv sdnn\\" 123,\n \\"latitude\\" 123 456789,\n \\"longitude\\" 123 456789,\n \\"pace avg\\" 123 45,\n \\"skin temperature\\" 123 45,\n \\"sleep breathing rate\\" 123 45,\n \\"sleep breathing rate avg\\" 123 45,\n \\"sleep breathing rate max\\" 123 45,\n \\"sleep breathing rate min\\" 123 45,\n \\"sleep duration\\" 123,\n \\"sleep duration awake\\" 123,\n \\"sleep duration deep\\" 123,\n \\"sleep duration light\\" 123,\n \\"sleep duration nap\\" 123,\n \\"sleep duration rem\\" 123,\n \\"sleep efficiency\\" 123,\n \\"sleep interruptions\\" 123,\n \\"sleep latency\\" 123,\n \\"sleep score\\" 123,\n \\"speed\\" 123 4567,\n \\"speed avg\\" 123 4567,\n \\"speed max\\" 123 4567,\n \\"speed min\\" 123 4567,\n \\"spo2\\" 123 4567,\n \\"spo2 avg\\" 123 4567,\n \\"spo2 max\\" 123 4567,\n \\"spo2 min\\" 123 4567,\n \\"steps\\" 123,\n \\"swimming distance per stroke\\" 123 45,\n \\"swimming lengths\\" 123,\n \\"vo2max\\" 123 45,\n \\"wakeup latency\\" 123,\n \\"weight\\" 123 4567\n },\n \\"modified at\\" \\"2019 08 24t14 15 22z\\",\n \\"provider slug\\" \\"fitbit\\",\n \\"provider source\\" \\"fitbit\\",\n \\"provider source type\\" \\"provider summary\\",\n \\"record id\\" \\"34e5506a c8b9 4e24 8937 25ad88b450c0\\",\n \\"source\\" {\n \\"device manufacturer\\" \\"string\\",\n \\"device model\\" \\"string\\",\n \\"device product\\" \\"string\\",\n \\"device version\\" \\"string\\",\n \\"source bundle identifier\\" \\"string\\",\n \\"source os version\\" \\"string\\",\n \\"source product\\" \\"string\\",\n \\"source version\\" \\"string\\"\n },\n \\"start at timestamp\\" \\"2019 08 24t14 15 22z\\",\n \\"user time offset minutes\\" 0\n }\n ],\n \\"timezone\\" \\"string\\",\n \\"to\\" \\"2019 08 24t14 15 22z\\"\n}", "customlabel" "" } ], "selectedlanguageid" "qfu6epz 8pp15gg8ebsdx" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "from", "kind" "required", "type" "string", "description" "the start date of the query based on the user timezone; inclusive\n\n", "" "required" }, { "name" "to", "kind" "required", "type" "string", "description" "the end date of the query based on the user timezone; non inclusive", "" "required" }, { "name" "providers", "kind" "optional", "type" "array", "description" "allowed values\ health connect; fitbit; garmin; huawei; whoop; suunto; apple; oura; polar; withings", "" "allowed values\ health connect; fitbit; garmin; huawei; whoop; suunto; apple; oura; polar; withings" }, { "name" "timezone", "kind" "optional", "type" "string", "description" "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\nexample america/new york", "" "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\nexample america/new york" }, { "name" "metrics", "kind" "optional", "type" "array", "description" "heartrate max; heartrate min; heartrate; heartrate resting; hrv rmssd; hrv sdnn; elevation max; elevation min; elevation gain; elevation loss; ascent; descent; calories burned active; calories burned basal; calories burned; calories intake; steps; floors climbed; distance; distance walking; distance cycling; distance running; distance wheelchair; distance swimming; speed; speed max; speed min; air temperature max; air temperature; air temperature min; spo2; spo2 max; spo2 min; longitude; latitude; elevation; duration active; swimming lengths; swimming distance per stroke; sleep efficiency; sleep duration; sleep duration deep; sleep duration light; sleep duration rem; sleep duration awake; bedtime duration; sleep interruptions; sleep duration nap; sleep score; sleep breathing rate; sleep breathing rate min; sleep breathing rate max; sleep latency; wakeup latency; cadence; cadence min; cadence max; pace; body mass index; weight; height; vo2max; body temperature; skin temperature; skin temperature max; skin temperature min; body temperature max; body temperature min", "" "heartrate max; heartrate min; heartrate; heartrate resting; hrv rmssd; hrv sdnn; elevation max; elevation min; elevation gain; elevation loss; ascent; descent; calories burned active; calories burned basal; calories burned; calories intake; steps; floors climbed; distance; distance walking; distance cycling; distance running; distance wheelchair; distance swimming; speed; speed max; speed min; air temperature max; air temperature; air temperature min; spo2; spo2 max; spo2 min; longitude; latitude; elevation; duration active; swimming lengths; swimming distance per stroke; sleep efficiency; sleep duration; sleep duration deep; sleep duration light; sleep duration rem; sleep duration awake; bedtime duration; sleep interruptions; sleep duration nap; sleep score; sleep breathing rate; sleep breathing rate min; sleep breathing rate max; sleep latency; wakeup latency; cadence; cadence min; cadence max; pace; body mass index; weight; height; vo2max; body temperature; skin temperature; skin temperature max; skin temperature min; body temperature max; body temperature min" } ], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "provide your bearer token in the authorization header when making requests to protected resources ", "" "authorization" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "from", "kind" "optional", "type" "string", "description" "" }, { "name" "records", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "activity id", "kind" "optional", "type" "string", "description" "" }, { "name" "activity tags", "kind" "optional", "type" "array", "description" "" }, { "name" "activity type", "kind" "optional", "type" "string", "description" "" }, { "name" "duration", "kind" "optional", "type" "string", "description" "" }, { "name" "end at timestamp", "kind" "optional", "type" "string", "description" "" }, { "name" "entries", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "division ref", "kind" "optional", "type" "integer", "description" "" }, { "name" "division type", "kind" "optional", "type" "string", "description" "" }, { "name" "duration", "kind" "optional", "type" "integer", "description" "" }, { "name" "end at", "kind" "optional", "type" "string", "description" "" }, { "name" "metrics", "kind" "optional", "type" "object", "description" "" }, { "name" "start at", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "input method", "kind" "optional", "type" "string", "description" "" }, { "name" "is source aggregated", "kind" "optional", "type" "boolean", "description" "" }, { "name" "metrics", "kind" "optional", "type" "object", "description" "" }, { "name" "modified at", "kind" "optional", "type" "string", "description" "" }, { "name" "provider slug", "kind" "optional", "type" "string", "description" "" }, { "name" "provider source", "kind" "optional", "type" "string", "description" "" }, { "name" "provider source type", "kind" "optional", "type" "string", "description" "" }, { "name" "record id", "kind" "optional", "type" "string", "description" "" }, { "name" "source", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "device manufacturer", "kind" "optional", "type" "string", "description" "" }, { "name" "device model", "kind" "optional", "type" "string", "description" "" }, { "name" "device product", "kind" "optional", "type" "string", "description" "" }, { "name" "device version", "kind" "optional", "type" "string", "description" "" }, { "name" "source bundle identifier", "kind" "optional", "type" "string", "description" "" }, { "name" "source os version", "kind" "optional", "type" "string", "description" "" }, { "name" "source product", "kind" "optional", "type" "string", "description" "" }, { "name" "source version", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "timezone", "kind" "optional", "type" "string", "description" "" }, { "name" "to", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "timezone", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "to", "kind" "optional", "type" "string", "description" "", "children" \[] } ] }