Daily Statistics

curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/statistics/daily \
  --header 'Authorization: Bearer <token>'

{
  "from_date": "2006-01-02",
  "statistics": [
    {
      "date": "2006-01-02",
      "record_ids": [
        "67910c06-971c-436e-b178-d2bf40bb1928"
      ],
      "values": {
        "activity_score": 83,
        "calories_burned_active": 1020.0991,
        "calories_burned_basal": 2000.1242,
        "calories_burned_total": 3020.2233,
        "distance_cycling": 20091.0022,
        "distance_running": 12000.1014,
        "distance_total": 5880.7021,
        "distance_walking": 1200.7022,
        "heartrate": 100,
        "heartrate_max": 120,
        "heartrate_min": 60,
        "heartrate_resting": 60,
        "hrv_rmssd": 45,
        "hrv_sdnn": 52,
        "recovery_score": 83,
        "sleep_duration_total": 3600000,
        "sleep_score": 70,
        "sleep_skin_temperature_deviation": -0.13,
        "steps": 10000,
        "stress_score": 70
      }
    }
  ],
  "to_date": "2006-01-02"
}

Daily Statistics

This endpoint returns daily statistics calculated based on the data available for a specific time period. The data is aggregated for each day based on the user’s local timezone.

Refer to the different statistics types in the Statistics Types section for more information on how the data is aggregated for each type.

User’s Local Timezone

The /statistics/daily endpoint uses the user’s local timezone for all its calculations. This approach ensures that the data reflects the user’s actual daily activity patterns, providing a more personalized view. By using the local timezone, the API tailors the data to the user’s specific context, which is particularly useful for applications that focus on individual user experiences. This approach contrasts with the /statistics endpoint, which uses Coordinated Universal Time (UTC) for calculations, offering a standardized global view.

Daily Statistics

curl --request GET \
  --url https://app-api.spikeapi.com/v3/queries/statistics/daily \
  --header 'Authorization: Bearer <token>'

{
  "from_date": "2006-01-02",
  "statistics": [
    {
      "date": "2006-01-02",
      "record_ids": [
        "67910c06-971c-436e-b178-d2bf40bb1928"
      ],
      "values": {
        "activity_score": 83,
        "calories_burned_active": 1020.0991,
        "calories_burned_basal": 2000.1242,
        "calories_burned_total": 3020.2233,
        "distance_cycling": 20091.0022,
        "distance_running": 12000.1014,
        "distance_total": 5880.7021,
        "distance_walking": 1200.7022,
        "heartrate": 100,
        "heartrate_max": 120,
        "heartrate_min": 60,
        "heartrate_resting": 60,
        "hrv_rmssd": 45,
        "hrv_sdnn": 52,
        "recovery_score": 83,
        "sleep_duration_total": 3600000,
        "sleep_score": 70,
        "sleep_skin_temperature_deviation": -0.13,
        "steps": 10000,
        "stress_score": 70
      }
    }
  ],
  "to_date": "2006-01-02"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from_date

string<date>

required

Start time of the query range in user's local timezone according to the provider, inclusive

Examples:

"2006-01-02"

to_date

string<date>

required

End time of the query range in user's local timezone according to the provider, inclusive

Examples:

"2006-01-02"

exclude_manual

boolean

default:false

Exclude manual metrics from the statistics

types

enum<string>[]

required

Minimum length: 1

Show child attributes

providers

string[]

Provider slugs

include_record_ids

boolean

default:false

Whether to include the record IDs in the response

device_types

enum<string>[]

Device types to include in the statistics

Show child attributes

Response

from_date

string<date>

required

Calendar date in user's local timezone according to the provider

Examples:

"2006-01-02"

statistics

object[] | null

required

Show child attributes

to_date

string<date>

required

Calendar date in user's local timezone according to the provider

Examples:

"2006-01-02"

Interval Statistics

Time Series

⌘I

Integrating with Spike API

API Reference: User Management

API Reference: Querying Data

API Reference: Nutrition AI

Release Notes

Daily Statistics

User’s Local Timezone

Authorizations

Query Parameters

Response