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 2 (V2)

Body

You can retrieve user body data by user_id and filter by date range


Get body 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.
Header Parameters
authorizationtoken
optional
String
Client access token (deprecated)
x-spike-auth
required
String
Client access token
Python
Node.js
Ruby
Java
Curl
|
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpClient httpClient = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.spikeapi.com/v2/metrics/body/?user_id=282812818&start_date=2020-05-01&end_date=2020-05-03"))
                .header("x-spike-auth", "fa0b3803-1111-2222-9788-eccce210d30c")
                .build();

        HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
RESPONSES
200
|
{
    "user_id": "19291291291",
    "type": "body",
    "source": [
        {
            "name": "fitbit",
            "status": "ok"
        }
    ],
    "data": [
          {
              "source": "fitbit",
              "timezone_offset": 3600,
              "body_data": {
                  "weight_kg": {
                      "value": 100.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 111.1
                          }
                      ]
                  },
                  "height_cm": {
                      "value": 100.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 111.1
                          }
                      ]
                  },
                  "BMI": {
                      "value": 10.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 11.2
                          }
                      ]
                  },
                  "bodyfat_percentage": {
                      "value": 10.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 11.2
                          }
                      ]
                  },
                  "bone_mass_g": {
                      "value": 10.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 11.2
                          }
                      ]
                  },
                  "muscle_mass_g": {
                      "value": 10.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 11.2
                          }
                      ]
                  },
                  "water_percentage": {
                      "value": 10.3,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "value": 11.2
                          }
                      ]
                  }
              },
              "temperature_data": {
                  "skin_temperature": {
                      "temperature_celsius": 36.6,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "temperature_celsius": 36.1111
                          }
                      ]
                  },
                  "core_temperature": {
                      "temperature_celsius": 36.6,
                      "timeseries": [
                          {
                              "timestamp": "2022-04-23T21:19:43",
                              "temperature_celsius": 36.1111
                          }
                      ]
                  },
                  "baseline_core_temperature": {
                      "temperature_celsius": 36.8,
                      "timeseries": [
                        { 
                            "timestamp": "2023-08-09T08:00:00Z",       
                            "temperature_celsius": 36.8 
                        }
                      ]
                  },
                  "diff_from_baseline_temperature": {
                      "diff_temperature_celsius": -1.6,
			          "timeseries": [
				            {
					          "timestamp": "2022-04-23T21:19:43",
					          "diff_temperature_celsius": -2.0
            				},
            				{
            				  "timestamp": "2022-04-23T21:19:43",
            				  "diff_temperature_celsius": 0.2
            				}
			          ]
		          }

              },
              "blood_pressure_data": [
                  {
                      "timestamp": "2022-04-23T21:19:43",
                      "systolic_blood_pressure": 120,
                      "diastolic_blood_pressure": 70
                  }
              ]
          }

<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">Body.timezone_offset</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Unit: Seconds</li>
    <li class="list">Example: 60</li>
</ul>
<p class="description">Time zone offset from UTC as seconds.</p>

<h3 class="h3">Body.body_data.weight_kg.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 100.9</li>
</ul>
<p class="description">The value of body weight in kgs</p>

<h3 class="h3">Body.body_data.weight_kg.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when weight was recorded</p>

<h3 class="h3">Body.body_data.weight_kg.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 99.2</li>
</ul>
<p class="description">value when weight was recorded</p>

<h3 class="h3">Body.body_data.height_cm.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 100.9</li>
</ul>
<p class="description">The value of height in cms</p>

<h3 class="h3">Body.body_data.height_cm.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when height was recorded</p>

<h3 class="h3">Body.body_data.height_cm.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 99.2</li>
</ul>
<p class="description">value when height was recorded</p>

<h3 class="h3">Body.body_data.BMI.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 10.9</li>
</ul>
<p class="description">The value of BMI</p>

<h3 class="h3">Body.body_data.BMI.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when BMI was recorded</p>

<h3 class="h3">Body.body_data.BMI.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 9.2</li>
</ul>
<p class="description">value when BMI was recorded</p>

<h3 class="h3">Body.body_data.bodyfat_percentage.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 10.9</li>
</ul>
<p class="description">The value of bodyfat percentage</p>

<h3 class="h3">Body.body_data.bodyfat_percentage.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when body fat percentage was recorded</p>

<h3 class="h3">Body.body_data.bodyfat_percentage.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 99.2</li>
</ul>
<p class="description">value when bodyfat percentage was recorded</p>

<h3 class="h3">Body.body_data.bone_mass_g.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 10.9</li>
</ul>
<p class="description">The value of Bone Mass</p>

<h3 class="h3">Body.body_data.bone_mass_g.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when Bone Mass was recorded</p>

<h3 class="h3">Body.body_data.bone_mass_g.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 9.2</li>
</ul>
<p class="description">value when Bone Mass was recorded</p>

<h3 class="h3">Body.body_data.muscle_mass_g.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 10.9</li>
</ul>
<p class="description">The value of Muscle Mass</p>

<h3 class="h3">Body.body_data.muscle_mass_g.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when muscle mass was recorded</p>

<h3 class="h3">Body.body_data.muscle_mass_g.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 9.2</li>
</ul>
<p class="description">value when muscle mass was recorded</p>

<h3 class="h3">Body.body_data.water_percentage.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 10.9</li>
</ul>
<p class="description">The value of water pecentage</p>

<h3 class="h3">Body.body_data.water_percentage.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when water percentage was recorded</p>

<h3 class="h3">Body.body_data.water_percentage.timeseries.value</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 99.2</li>
</ul>
<p class="description">value when water percentage was recorded</p>

<h3 class="h3">Body.temperature_data.skin_temprature.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.9</li>
</ul>
<p class="description">The value of skin temprature in celcius</p>

<h3 class="h3">Body.temperature_data.skin_temprature.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when skin temprature was recorded</p>

<h3 class="h3">Body.temperature_data.skin_temprature.timeseries.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.2</li>
</ul>
<p class="description">value when skin temprature was recorded</p>

<h3 class="h3">Body.temperature_data.core_temprature.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.9</li>
</ul>
<p class="description">The value of core temprature in celcius</p>

<h3 class="h3">Body.temperature_data.core_temprature.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when core temprature was recorded</p>

<h3 class="h3">Body.temperature_data.core_temprature.timeseries.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.2</li>
</ul>
<p class="description">value when core temprature was recorded</p>

<h3 class="h3">Body.temperature_data.baseline_core_temprature.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.9</li>
</ul>
<p class="description">The value of core temprature in celcius</p>

<h3 class="h3">Body.temperature_data.baseline_core_temprature.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when core temprature was recorded</p>

<h3 class="h3">Body.temperature_data.baseline_core_temprature.timeseries.temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.2</li>
</ul>
<p class="description">value when core temprature was recorded</p>

<h3 class="h3">Body.temperature_data.diff_from_baseline_temperature.diff_temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.9</li>
</ul>
<p class="description">The value of difference from Baseline Temprature in celcius</p>

<h3 class="h3">Body.temperature_data.diff_from_baseline_temperature.timeseries.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when core temprature was recorded</p>

<h3 class="h3">Body.temperature_data.diff_from_baseline_temperature.timeseries.diff_temperature_celsius</h3>
<ul class="list-wrapper">
    <li class="list">Type: Float</li>
    <li class="list">Example: 36.2</li>
</ul>
<p class="description">value when core temprature was recorded</p>
<h3 class="h3">Body.blood_pressure_data.timestamp</h3>
<ul class="list-wrapper">
    <li class="list">Type: String</li>
    <li class="list">Format: Date time, YYYY-MM-DDThh:mm:ss</li>
    <li class="list">Example: 2021-05-01T09:36:13</li>
</ul>
<p class="description">Local time when blood pressure was recorded</p>

<h3 class="h3">Body.blood_pressure_data.systolic_blood_pressure</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 120</li>
</ul>
<p class="description">Systolic blood pressure value</p>

<h3 class="h3">Body.blood_pressure_data.diastolic_blood_pressure</h3>
<ul class="list-wrapper">
    <li class="list">Type: Int</li>
    <li class="list">Example: 80</li>
</ul>
<p class="description">Diastolic blood pressure value</p>




Did this page help you?
PREVIOUS
Heart
NEXT
Info
Docs powered by
Archbee
Get Body Data
TABLE OF CONTENTS
GET
Get Body Data
Docs powered by
Archbee