API Reference: Querying Data

Statistics

Statistics are calculated based on the data available for a specific time period. The data is aggregated according to the time interval specified in your request. This means that if you request data with an hourly interval, the statistics will be aggregated and presented for each hour within the specified time range.

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.

Coordinated Universal Time

The /statistics endpoint uses Coordinated Universal Time (UTC) for all its calculations. This standardization ensures that data is consistent and comparable across different time zones. By using UTC, the API provides a global view of the data, which is crucial for applications that require a uniform time reference. This approach contrasts with the /statistics/daily endpoint, which uses the user’s local timezone for calculations, offering a more personalized view.

Statistics

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

{
  "from_timestamp": "2006-01-02T00:00:00Z",
  "record_ids": [
    "1aef962e-e41b-4da4-8deb-5462dedb0f35"
  ],
  "to_timestamp": "2006-01-02T00:00:00Z",
  "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_timestamp

string

Start time of the query range in UTC

Examples:

"2006-01-02T15:04:05"

"2006-01-02T15:04:05Z"

to_timestamp

string

End time of the query range in UTC

Examples:

"2006-01-02T15:04:05"

"2006-01-02T15:04:05Z"

exclude_manual

boolean

default:false

Exclude manual metrics from the statistics

interval

enum<string>

required

Interval windows to aggregate data

Available options:

fifteen_minute,

thirty_minute,

hour,

day

types

enum<string>[]

required

Show child attributes

providers

enum<string>[]

Show child attributes

Response

200

application/json

The response is of type object.

Get Sleep

Daily Statistics

Statistics

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

{
  "from_timestamp": "2006-01-02T00:00:00Z",
  "record_ids": [
    "1aef962e-e41b-4da4-8deb-5462dedb0f35"
  ],
  "to_timestamp": "2006-01-02T00:00:00Z",
  "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

Statistics

Coordinated Universal Time

Authorizations

Query Parameters

Response