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}/{stype}

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.
stype string The type of statistics to retrieve. Possible values are: HRV, SLEEP_DURATION, SLEEP_REGULARITY, 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: Successfully retrieved overview data.
  • 400 Bad Request: Invalid parameters provided.
  • 401 Unauthorized: Authentication required.
  • 404 Not Found: User not found or no data available for the specified type.

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/STRESS_DURATION?start_date=2023-01-01&end_date=2023-01-31" \
     -H "accept: text/csv" \
     -H "X-API-Key: YOUR_API_KEY"

Example JSON Responses

HRV

[
  {
    "date": "2023-01-01",
    "hrv_daily": 40.5,
    "hrv_typical": 42.0,
    "hrv_upper_deviation": 5.0,
    "hrv_lower_deviation": 3.0,
    "hrv_descriptive": "Your HRV is stable."
  }
]

SLEEP_DURATION

[
  {
    "date": "2023-01-01",
    "sleep_duration_daily": 480.0,
    "sleep_duration_typical": 450.0,
    "sleep_duration_descriptive": "You slept well."
  }
]

SLEEP_REGULARITY

[
  {
    "date": "2023-01-01",
    "sleep_bedtime_daily": "2023-01-01T23:00:00Z",
    "sleep_waketime_daily": "2023-01-02T07:00:00Z",
    "sleep_bedtime_typical": 23.0,
    "sleep_waketime_typical": 7.0,
    "sleep_regularity_descriptive": "Your sleep schedule is consistent."
  }
]

INTENSE_ACTIVITY

[
  {
    "date": "2023-01-01",
    "intense_activity_daily": 60.0,
    "intense_activity_regularity": 0.75,
    "intense_activity_descriptive": "You had a good amount of intense activity."
  }
]

RHR

[
  {
    "date": "2023-01-01",
    "rhr_daily": 60.0,
    "rhr_typical": 62.0,
    "rhr_upper_deviation": 2.0,
    "rhr_lower_deviation": 1.0,
    "rhr_descriptive": "Your resting heart rate is normal."
  }
]

STRESS_DURATION

[
  {
    "date": "2023-01-01",
    "stress_duration_daily": 120.0,
    "stress_duration_typical": 100.0,
    "stress_duration_lower_deviation": 10.0,
    "stress_duration_upper_deviation": 15.0,
    "stress_duration_descriptive": "You experienced more stress than usual."
  }
]

STRESS_RECOVERY

[
  {
    "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_recovery_descriptive": "Your stress recovery was faster than average."
  }
]

STRESS_FREQUENCY

[
  {
    "date": "2023-01-01",
    "stress_frequency_daily": 5.0,
    "stress_frequency_descriptive": "You had a moderate number of stressors."
  }
]