API Reference: Querying Data

Daily Statistics

Daily Statistics are 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. The aggregation process involves summing up or averaging the data points within each interval, depending on the type of statistic being queried. This allows you to see trends and patterns over time, making it easier to analyze the data and draw meaningful insights.

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.

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

{
  "date": "2006-01-02",
  "record_ids": [
    "e70d239d-08c8-44a3-8f4f-7c9784877f10"
  ],
  "values": {
    "calories_burned_active": 123.4567,
    "calories_burned_basal": 123.4567,
    "calories_burned_total": 123.4567,
    "distance_cycling": 123.4567,
    "distance_running": 123.4567,
    "distance_total": 123.4567,
    "distance_walking": 123.4567,
    "heartrate": 123,
    "heartrate_max": 123,
    "heartrate_min": 123,
    "heartrate_resting": 123,
    "sleep_duration_total": 123,
    "sleep_score": 123,
    "steps": 123
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

from_date

string

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

Examples:

"2006-01-02"

to_date

string

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

Examples:

"2006-01-02"

exclude_manual

boolean

default:false

Exclude manual metrics from the statistics

types

enum<string>[]

required

Statistics values

Minimum length: 1

Show child attributes

providers

string[] | null

Provider slugs

Response

200

application/json

The response is of type object.

List WorkoutsList workouts for a user

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

{
  "date": "2006-01-02",
  "record_ids": [
    "e70d239d-08c8-44a3-8f4f-7c9784877f10"
  ],
  "values": {
    "calories_burned_active": 123.4567,
    "calories_burned_basal": 123.4567,
    "calories_burned_total": 123.4567,
    "distance_cycling": 123.4567,
    "distance_running": 123.4567,
    "distance_total": 123.4567,
    "distance_walking": 123.4567,
    "heartrate": 123,
    "heartrate_max": 123,
    "heartrate_min": 123,
    "heartrate_resting": 123,
    "sleep_duration_total": 123,
    "sleep_score": 123,
    "steps": 123
  }
}

Integrating with SpikeAPI

API Reference: User Management

API Reference: Querying Data

Types and Definitions

Release Notes

Daily Statistics

User’s Local Timezone

Authorizations

Query Parameters

Response