website logo
⌘K
Quickstart
User
Metrics
Webhooks
Mobile SDK
V2
React Native
Flutter
Android (Kotlin)
Swift
V1
Errors
FAQ
Docs powered by
Archbee
Metrics
API Version 1 (V1)

Activities Summary

You can retrieve user activities summary data by user_id and filter by date range


Get a activity summary data by user_id
GET
Params
Query Parameters
user_id
required
String
User ID returned by add integration request. This key should be stored in your database against the user and used for all interactions with the Spike API.
start_date
required
String
Date from in YYYY-MM-DD format
end_date
required
String
Date to in YYYY-MM-DD format
Header Parameters
authorizationtoken
optional
String
Client access token (deprecated)
x-spike-auth
required
String
Client access token
Python
|
import requests

url = "https://api.spikeapi.com/metrics/activities_summary/?user_id=282812818&start_date=2020-05-01&end_date=2020-05-03"
headers = {}
headers['x-spike-auth'] = 'fa0b3803-1111-2222-9788-eccce210d30c'
response = requests.request("GET", url, headers=headers)

print(response.text)
RESPONSES
200
|
{
    "user_key": "19291291291",
    "start_date": "2020-05-01",
    "end_date": "2020-05-03",
    "type": "activitie_summary",
    "sources": [
       {
            "name": "fitbit",
            "status": "ok"
        }
    ],
	"data": [
	  {
	   "date": "2020-05-01",
	   "calories_bmr": 1973,
	   "calories_total": 2300,
	   "calories_active": 1900,
	   "steps": 10000,
	   "daily_movement": 9000,
       "distance": 12000.0,
	   "low": 300,
	   "medium": 200,
	   "high": 100,
	   "elevation": 0,
	   "resting_hr": 77,
	   "floors": 0,
	   "sedentary_minutes": 802,
       "min_hr": 48,
       "avg_hr": 66,
       "max_hr": 117,
       "avg_stress_level": 24,
       "max_stress_level": 99,
       "stress_duration": 10680,
       "low_stress_duration": 5580,
       "medium_stress_duration": 2280,
       "high_stress_duration": 2820,
	   "source": "fitbit",
	  }
    ]
}

<style>
@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300&display=swap');

.h2, .h3, .list, .description{
	font-family: 'Poppins', sans-serif;
	font-weight: 500;
}

.h2 {
    margin-top: -20px;
    margin-bottom: 20px;

    font-size: 30px;
}

.h3 {
    font-size: 22px;
	margin-top: -20px;
}

.list-wrapper {
    white-space: normal;
     margin-top: -10px;
}

.list, .description {
    font-size: 14px;
}

</style>
<h2 class="h2">Fields</h2>
<h3 class="h3">Activity_summary.date</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date, YYYY-MM-DD</li>
    <li class="list">Example: 2021-05-01</li>
</ul><p class="description">Summary date in YYYY-MM-DD format. For Whoop, date when the cycle ended</p>

<h3 class="h3">Activity_summary.calories_bmr</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: kcal</li>
    <li class="list">Example: 1973</li>
</ul><p class="description">Total BMR calories burned for the day.</p>

<h3 class="h3">Activity_summary.calories_total</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: kcal</li>
    <li class="list">Example: 2500</li>
</ul><p class="description">Total calories burned for the day (daily timeseries total)</p>

<h3 class="h3">Activity_summary.calories_active</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: kcal</li>
    <li class="list">Example: 350</li>
</ul><p class="description">The number of calories burned for the day during periods the user was active above sedentary level. This includes both activity burned calories and BMR.</p>

<h3 class="h3">Activity_summary.steps</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: step</li>
    <li class="list">Example: 8000</li>
</ul><p class="description">Total steps taken for the day</p>

<h3 class="h3">Activity_summary.daily_movement</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Meters</li>
    <li class="list">Example: 700</li>
</ul><p class="description">Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity</p>

<h3 class="h3">Activity_summary.distance</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Unit: Meters</li>
    <li class="list">Example: 1700.0</li>
</ul><p class="description">Distance for a day</p>

<h3 class="h3">Activity_summary.low</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Minutes</li>
    <li class="list">Example: 300</li>
</ul><p class="description">Number of minutes during the day with low intensity activity</p>

<h3 class="h3">Activity_summary.medium</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Minutes</li>
    <li class="list">Example: 200</li>
</ul><p class="description">Number of minutes during the day with medium intensity activity </p>

<h3 class="h3">Activity_summary.high</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Minutes</li>
    <li class="list">Example: 100</li>
</ul><p class="description">Number of minutes during the day with high intensity activity </p>

<h3 class="h3">Activity_summary.elevation</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Meters</li>
    <li class="list">Example: 200</li>
</ul><p class="description">The elevation traveled for the day (meters)</p>

<h3 class="h3">Activity_summary.resting_hr</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 77</li>
</ul><p class="description">Resting heart rate</p>

<h3 class="h3">Activity_summary.floors</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 2</li>
</ul><p class="description">The equivalent floors climbed for the day</p>

<h3 class="h3">Activity_summary.sedentary_minutes</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Minutes</li>
    <li class="list">Example: 802</li>
</ul><p class="description">Total minutes the user was sedentary</p>

<h3 class="h3">Activity_summary.min_hr</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 48</li>
</ul><p class="description">Minimum heart rate</p>

<h3 class="h3">Activity_summary.avg_hr</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 66</li>
</ul><p class="description">Average heart rate</p>

<h3 class="h3">Activity_summary.max_hr</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Beats per minute</li>
    <li class="list">Example: 117</li>
</ul><p class="description">Maximum heart rate</p>

<h3 class="h3">Activity_summary.avg_stress_level</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 32</li>
</ul><p class="description">An abstraction of the user’s average stress level in this monitoring period, measured from 1 to 100, or -1 if there is not enough data to calculate average stress.</p>

<h3 class="h3">Activity_summary.max_stress_level</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 99</li>
</ul><p class="description">The highest stress level measurement taken during this monitoring period.</p>

<h3 class="h3">Activity_summary.stress_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 10680</li>
</ul><p class="description">The number of seconds in this monitoring period where stress level measurements were in the stressful range (26-100).</p>

<h3 class="h3">Activity_summary.low_stress_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 5580</li>
</ul><p class="description">The portion of the user’s stress duration where the measured stress score was in the low range (26-50).</p>

<h3 class="h3">Activity_summary.medium_stress_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2280</li>
</ul><p class="description">The portion of the user’s stress duration where the measured stress score was in the medium range (51-75).</p>

<h3 class="h3">Activity_summary.high_stress_duration</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 2820</li>
</ul><p class="description">The portion of the user’s stress duration where the measured stress score was in the high range (76-100).</p>

<h3 class="h3">Activity_summary.source</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Example: fitbit</li>
</ul><p class="description">Source the data has come from</p>




Did this page help you?
PREVIOUS
Standardized Names and IDs
NEXT
Sleep
Docs powered by
Archbee
Get Activity summary data
TABLE OF CONTENTS
GET
Get Activity summary data
Docs powered by
Archbee