Skip to content

Overview API Reference

This section provides details on the API endpoints related to Overview data.

API specification

The OpenAPI 3.1 document is the source of truth for the API:

Get Overview Data by Type

GET /v1/overview/{user_id}/{type}

Retrieves aggregated overview data for a user for a specific statistics type.

Parameters

Name Type Description
user_id string (UUID) The ID of the user.
type string The type of statistics to retrieve. Possible values are: HRV, SLEEP_DURATION, SLEEP_REGULARITY, SKIN_TEMPERATURE, INTENSE_ACTIVITY, RHR, STRESS_DURATION, STRESS_RECOVERY, STRESS_FREQUENCY.
start_date string (date) Start date for the data retrieval (YYYY-MM-DD).
end_date string (date) End date for the data retrieval (YYYY-MM-DD).

Responses

200 ok

The request was successful. A date range with no data returns 200 with an empty list.

406 not acceptable

An unsupported Accept header was requested.

See Errors for authentication, validation, and rate-limit responses.

Example Request (JSON)

curl -X GET "https://research-api.nowatch.com/v1/overview/YOUR_USER_ID/HRV?start_date=2023-01-01&end_date=2023-01-31" \
     -H "accept: application/json" \
     -H "X-API-Key: YOUR_API_KEY"

Example Request (CSV)

curl -X GET "https://research-api.nowatch.com/v1/overview/YOUR_USER_ID/SLEEP_DURATION?start_date=2023-01-01&end_date=2023-01-31" \
     -H "accept: text/csv" \
     -H "X-API-Key: YOUR_API_KEY"

Example Responses

HRV

JSON Response
[
  {
    "date": "2023-01-01",
    "hrv_daily": 40.5,
    "hrv_typical": 42.0,
    "hrv_upper_deviation": 5.0,
    "hrv_lower_deviation": 3.0
  }
]

SLEEP_DURATION

CSV Response
date,sleep_duration_daily,sleep_duration_typical
2023-01-01,480.0,450.0

SLEEP_REGULARITY

JSON Response
[
  {
    "date": "2023-01-01",
    "sleep_bedtime_daily": "2023-01-01T23:00:00.000Z",
    "sleep_waketime_daily": "2023-01-02T07:00:00.000Z",
    "sleep_bedtime_typical": 23.0,
    "sleep_waketime_typical": 7.0
  }
]

INTENSE_ACTIVITY

CSV Response
date,intense_activity_daily,intense_activity_regularity,intense_activity_label
2023-01-01,60.0,0.75,ACTIVE

RHR

JSON Response
[
  {
    "date": "2023-01-01",
    "rhr_daily": 60.0,
    "rhr_typical": 62.0,
    "rhr_upper_deviation": 2.0,
    "rhr_lower_deviation": 1.0
  }
]

STRESS_DURATION

CSV Response
date,stress_duration_daily,stress_duration_typical,stress_duration_lower_deviation,stress_duration_upper_deviation
2023-01-01,120.0,100.0,10.0,15.0

STRESS_RECOVERY

JSON Response
[
  {
    "date": "2023-01-01",
    "stress_recovery_daily": 30.0,
    "stress_recovery_typical": 40.0,
    "stress_recovery_lower_deviation": 5.0,
    "stress_recovery_upper_deviation": 8.0
  }
]

STRESS_FREQUENCY

CSV Response
date,stress_frequency_daily
2023-01-01,5.0

SKIN_TEMPERATURE

Deviation from the personal skin-temperature baseline (°C); deviation-only, so there is no _typical.

JSON Response
[
  {
    "date": "2023-01-01",
    "skin_temperature_daily": 0.5,
    "skin_temperature_lower_deviation": 0.3,
    "skin_temperature_upper_deviation": 0.3
  }
]