Skip to content

NOWATCH API (0.9.0)

The NOWATCH API

Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.api.nowatch.tech/_mock/apis/

https://docs.api.nowatch.tech/nowatch/

Operations
Operations

firmware

Firmware updates and downloads

Operations

admin-firmware

Admin firmware management

Operations

measurement

Time series health data (heart rate, temperature, activity, etc.)

Operations

insight

User insights, feedback, and reflections

Operations
Operations

checkin

User check-ins and wellness tracking

Operations
Operations

day-feedback

Daily feedback and mood tracking

Operations
Operations

activity

Sessions wrapper for activities

Operations

intention

Sessions wrapper for intentions

Operations

statistics

Aggregated health statistics

Operations

Request

For more information visit Statistics Context

Security
bearer
Query
start_daystringrequired

Start date in YYYY-MM-DD format

Example: start_day=2024-03-20
end_daystringrequired

End date in YYYY-MM-DD format

Example: end_day=2024-03-20
typeArray of stringsrequired
Items Enum"STRESS_DURATION""STRESS_RECOVERY""STRESS_FREQUENCY""INTENSE_ACTIVITY""DAYTIME_RESTING_HEART_RATE""SLEEP_HRV""SLEEP_DURATION""SLEEP_REGULARITY""SLEEP_STAGES""SLEEP_CYCLES"
Headers
shared-userstring

The ID of the user to fetch measurements for (optional)

curl -i -X GET \
  'https://docs.api.nowatch.tech/_mock/apis/v1/statistics?start_day=2024-03-20&end_day=2024-03-20&type=STRESS_DURATION' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'shared-user: string'

Responses

Bodyapplication/jsonArray [
datestring(date-time)required
dataobjectrequired
typestringrequired
createdstring(date-time)required
lastUpdatedstring(date-time)required
timeFilterArray of stringsrequired
timeSpanstringrequired
enoughDatabooleanrequired
versionstringrequired
metadataobjectrequired
]
Response
application/json
[ { "date": "2019-08-24T14:15:22Z", "data": {}, "type": "string", "created": "2019-08-24T14:15:22Z", "lastUpdated": "2019-08-24T14:15:22Z", "timeFilter": [ … ], "timeSpan": "string", "enoughData": true, "version": "string", "metadata": {} } ]

Request

For more information visit Statistics Context

Security
bearer
Bodyapplication/jsonrequired
dataArray of objects(IncomingStatisticsDto)required
data[].​dataobjectrequired
data[].​timeFilterArray of stringsrequired
Items Enum"NONE""SUNDAYS""MONDAYS""TUESDAYS""WEDNESDAYS""THURSDAYS""FRIDAYS""SATURDAYS""NIGHTS""MORNINGS"
Example: ["SUNDAYS"]
data[].​timeSpanstringrequired
Enum"ONE_DAY""ONE_WEEK""ONE_MONTH""ONE_YEAR""TWO_WEEKS""TWO_MONTHS""THREE_MONTHS""SIX_MONTHS""ALL_TIME"
Example: "ONE_DAY"
data[].​versionstringrequired

Algorithm version, stored in the format of YYYY.MM.DD.X

Example: "2025.05.23.1"
data[].​enoughDatabooleanrequired

Indicates if the statistics has enough data to be used for analysis

data[].​metadataobjectrequired

Metadata about the statistics, right now it's stored in the format of { 'appVersion': 'YYYY.MM.DD.X', 'platform': 'ios' | 'android' }

Example: {"appVersion":"2025.05.23.1","platform":"ios"}
data[].​datestring(date-time)required
Example: "2024-03-20"
data[].​typestringrequired
Enum"STRESS_DURATION""STRESS_RECOVERY""STRESS_FREQUENCY""INTENSE_ACTIVITY""DAYTIME_RESTING_HEART_RATE""SLEEP_HRV""SLEEP_DURATION""SLEEP_REGULARITY""SLEEP_STAGES""SLEEP_CYCLES"
Example: "'STRESS_DURATION' | 'STRESS_RECOVERY' | 'STRESS_FREQUENCY' | 'INTENSE_ACTIVITY' | 'DAYTIME_RESTING_HEART_RATE' | 'SLEEP_HRV' | 'SLEEP_DURATION' | 'SLEEP_REGULARITY' | 'SLEEP_STAGES' | 'SLEEP_CYCLES' | 'AWAKE_DURATION' | 'WAKE_HOUR' | 'STEP_COUNT' | 'STRESSOR_RECOVERY_TIME' | 'STRESSORS' | 'HEART_RATE' | 'RESTING_HEART_RATE' | 'HRV' | 'REACTIVITY' | 'ACTIVITIES_DURATION' | 'ACTIVITY_COUNT' | 'REACTIVITY_DURING_STRESSORS' | 'LOW_REACTIVITY_DURATION' | 'STRESS_DURATION_DESCRIPTIVE' | 'STRESS_RECOVERY_DESCRIPTIVE' | 'STRESS_FREQUENCY_DESCRIPTIVE' | 'STRESS_DESCRIPTIVE' | 'INTENSE_ACTIVITY_DESCRIPTIVE' | 'RESTING_HEART_RATE_DESCRIPTIVE' | 'SLEEP_DURATION_DESCRIPTIVE' | 'SLEEP_REGULARITY_DESCRIPTIVE' | 'HRV_DESCRIPTIVE' | 'SLEEP' | 'TEMPERATURE' | 'TEMPERATURE_DESCRIPTIVE'"
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/statistics \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "data": {},
        "timeFilter": [
          "SUNDAYS"
        ],
        "timeSpan": "ONE_DAY",
        "version": "2025.05.23.1",
        "enoughData": true,
        "metadata": {
          "appVersion": "2025.05.23.1",
          "platform": "ios"
        },
        "date": "2024-03-20",
        "type": "'\''STRESS_DURATION'\'' | '\''STRESS_RECOVERY'\'' | '\''STRESS_FREQUENCY'\'' | '\''INTENSE_ACTIVITY'\'' | '\''DAYTIME_RESTING_HEART_RATE'\'' | '\''SLEEP_HRV'\'' | '\''SLEEP_DURATION'\'' | '\''SLEEP_REGULARITY'\'' | '\''SLEEP_STAGES'\'' | '\''SLEEP_CYCLES'\'' | '\''AWAKE_DURATION'\'' | '\''WAKE_HOUR'\'' | '\''STEP_COUNT'\'' | '\''STRESSOR_RECOVERY_TIME'\'' | '\''STRESSORS'\'' | '\''HEART_RATE'\'' | '\''RESTING_HEART_RATE'\'' | '\''HRV'\'' | '\''REACTIVITY'\'' | '\''ACTIVITIES_DURATION'\'' | '\''ACTIVITY_COUNT'\'' | '\''REACTIVITY_DURING_STRESSORS'\'' | '\''LOW_REACTIVITY_DURATION'\'' | '\''STRESS_DURATION_DESCRIPTIVE'\'' | '\''STRESS_RECOVERY_DESCRIPTIVE'\'' | '\''STRESS_FREQUENCY_DESCRIPTIVE'\'' | '\''STRESS_DESCRIPTIVE'\'' | '\''INTENSE_ACTIVITY_DESCRIPTIVE'\'' | '\''RESTING_HEART_RATE_DESCRIPTIVE'\'' | '\''SLEEP_DURATION_DESCRIPTIVE'\'' | '\''SLEEP_REGULARITY_DESCRIPTIVE'\'' | '\''HRV_DESCRIPTIVE'\'' | '\''SLEEP'\'' | '\''TEMPERATURE'\'' | '\''TEMPERATURE_DESCRIPTIVE'\''"
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
datestring(date-time)required
dataobjectrequired
typestringrequired
createdstring(date-time)required
lastUpdatedstring(date-time)required
timeFilterArray of stringsrequired
timeSpanstringrequired
enoughDatabooleanrequired
versionstringrequired
metadataobjectrequired
]
Response
application/json
[ { "date": "2019-08-24T14:15:22Z", "data": {}, "type": "string", "created": "2019-08-24T14:15:22Z", "lastUpdated": "2019-08-24T14:15:22Z", "timeFilter": [ … ], "timeSpan": "string", "enoughData": true, "version": "string", "metadata": {} } ]

Create or update multiple statistics

Request

For more information visit Statistics Context

Security
bearer
Bodyapplication/jsonrequired
dataArray of objects(IncomingStatisticsDto)required
data[].​dataobjectrequired
data[].​timeFilterArray of stringsrequired
Items Enum"NONE""SUNDAYS""MONDAYS""TUESDAYS""WEDNESDAYS""THURSDAYS""FRIDAYS""SATURDAYS""NIGHTS""MORNINGS"
Example: ["SUNDAYS"]
data[].​timeSpanstringrequired
Enum"ONE_DAY""ONE_WEEK""ONE_MONTH""ONE_YEAR""TWO_WEEKS""TWO_MONTHS""THREE_MONTHS""SIX_MONTHS""ALL_TIME"
Example: "ONE_DAY"
data[].​versionstringrequired

Algorithm version, stored in the format of YYYY.MM.DD.X

Example: "2025.05.23.1"
data[].​enoughDatabooleanrequired

Indicates if the statistics has enough data to be used for analysis

data[].​metadataobjectrequired

Metadata about the statistics, right now it's stored in the format of { 'appVersion': 'YYYY.MM.DD.X', 'platform': 'ios' | 'android' }

Example: {"appVersion":"2025.05.23.1","platform":"ios"}
data[].​datestring(date-time)required
Example: "2024-03-20"
data[].​typestringrequired
Enum"STRESS_DURATION""STRESS_RECOVERY""STRESS_FREQUENCY""INTENSE_ACTIVITY""DAYTIME_RESTING_HEART_RATE""SLEEP_HRV""SLEEP_DURATION""SLEEP_REGULARITY""SLEEP_STAGES""SLEEP_CYCLES"
Example: "'STRESS_DURATION' | 'STRESS_RECOVERY' | 'STRESS_FREQUENCY' | 'INTENSE_ACTIVITY' | 'DAYTIME_RESTING_HEART_RATE' | 'SLEEP_HRV' | 'SLEEP_DURATION' | 'SLEEP_REGULARITY' | 'SLEEP_STAGES' | 'SLEEP_CYCLES' | 'AWAKE_DURATION' | 'WAKE_HOUR' | 'STEP_COUNT' | 'STRESSOR_RECOVERY_TIME' | 'STRESSORS' | 'HEART_RATE' | 'RESTING_HEART_RATE' | 'HRV' | 'REACTIVITY' | 'ACTIVITIES_DURATION' | 'ACTIVITY_COUNT' | 'REACTIVITY_DURING_STRESSORS' | 'LOW_REACTIVITY_DURATION' | 'STRESS_DURATION_DESCRIPTIVE' | 'STRESS_RECOVERY_DESCRIPTIVE' | 'STRESS_FREQUENCY_DESCRIPTIVE' | 'STRESS_DESCRIPTIVE' | 'INTENSE_ACTIVITY_DESCRIPTIVE' | 'RESTING_HEART_RATE_DESCRIPTIVE' | 'SLEEP_DURATION_DESCRIPTIVE' | 'SLEEP_REGULARITY_DESCRIPTIVE' | 'HRV_DESCRIPTIVE' | 'SLEEP' | 'TEMPERATURE' | 'TEMPERATURE_DESCRIPTIVE'"
curl -i -X PUT \
  https://docs.api.nowatch.tech/_mock/apis/v1/statistics/batch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "data": {},
        "timeFilter": [
          "SUNDAYS"
        ],
        "timeSpan": "ONE_DAY",
        "version": "2025.05.23.1",
        "enoughData": true,
        "metadata": {
          "appVersion": "2025.05.23.1",
          "platform": "ios"
        },
        "date": "2024-03-20",
        "type": "'\''STRESS_DURATION'\'' | '\''STRESS_RECOVERY'\'' | '\''STRESS_FREQUENCY'\'' | '\''INTENSE_ACTIVITY'\'' | '\''DAYTIME_RESTING_HEART_RATE'\'' | '\''SLEEP_HRV'\'' | '\''SLEEP_DURATION'\'' | '\''SLEEP_REGULARITY'\'' | '\''SLEEP_STAGES'\'' | '\''SLEEP_CYCLES'\'' | '\''AWAKE_DURATION'\'' | '\''WAKE_HOUR'\'' | '\''STEP_COUNT'\'' | '\''STRESSOR_RECOVERY_TIME'\'' | '\''STRESSORS'\'' | '\''HEART_RATE'\'' | '\''RESTING_HEART_RATE'\'' | '\''HRV'\'' | '\''REACTIVITY'\'' | '\''ACTIVITIES_DURATION'\'' | '\''ACTIVITY_COUNT'\'' | '\''REACTIVITY_DURING_STRESSORS'\'' | '\''LOW_REACTIVITY_DURATION'\'' | '\''STRESS_DURATION_DESCRIPTIVE'\'' | '\''STRESS_RECOVERY_DESCRIPTIVE'\'' | '\''STRESS_FREQUENCY_DESCRIPTIVE'\'' | '\''STRESS_DESCRIPTIVE'\'' | '\''INTENSE_ACTIVITY_DESCRIPTIVE'\'' | '\''RESTING_HEART_RATE_DESCRIPTIVE'\'' | '\''SLEEP_DURATION_DESCRIPTIVE'\'' | '\''SLEEP_REGULARITY_DESCRIPTIVE'\'' | '\''HRV_DESCRIPTIVE'\'' | '\''SLEEP'\'' | '\''TEMPERATURE'\'' | '\''TEMPERATURE_DESCRIPTIVE'\''"
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
datestring(date-time)required
dataobjectrequired
typestringrequired
createdstring(date-time)required
lastUpdatedstring(date-time)required
timeFilterArray of stringsrequired
timeSpanstringrequired
enoughDatabooleanrequired
versionstringrequired
metadataobjectrequired
]
Response
application/json
[ { "date": "2019-08-24T14:15:22Z", "data": {}, "type": "string", "created": "2019-08-24T14:15:22Z", "lastUpdated": "2019-08-24T14:15:22Z", "timeFilter": [ … ], "timeSpan": "string", "enoughData": true, "version": "string", "metadata": {} } ]

Create or update a single statistic

Request

For more information visit Statistics Context

Security
bearer
Path
datestring(date-time)required

Date in YYYY-MM-DD format

Example: 2024-03-20
typestringrequired
Enum"STRESS_DURATION""STRESS_RECOVERY""STRESS_FREQUENCY""INTENSE_ACTIVITY""DAYTIME_RESTING_HEART_RATE""SLEEP_HRV""SLEEP_DURATION""SLEEP_REGULARITY""SLEEP_STAGES""SLEEP_CYCLES"
Bodyapplication/jsonrequired
dataobjectrequired
timeFilterArray of stringsrequired
Items Enum"NONE""SUNDAYS""MONDAYS""TUESDAYS""WEDNESDAYS""THURSDAYS""FRIDAYS""SATURDAYS""NIGHTS""MORNINGS"
Example: ["SUNDAYS"]
timeSpanstringrequired
Enum"ONE_DAY""ONE_WEEK""ONE_MONTH""ONE_YEAR""TWO_WEEKS""TWO_MONTHS""THREE_MONTHS""SIX_MONTHS""ALL_TIME"
Example: "ONE_DAY"
versionstringrequired

Algorithm version, stored in the format of YYYY.MM.DD.X

Example: "2025.05.23.1"
enoughDatabooleanrequired

Indicates if the statistics has enough data to be used for analysis

metadataobjectrequired

Metadata about the statistics, right now it's stored in the format of { 'appVersion': 'YYYY.MM.DD.X', 'platform': 'ios' | 'android' }

Example: {"appVersion":"2025.05.23.1","platform":"ios"}
curl -i -X PUT \
  'https://docs.api.nowatch.tech/_mock/apis/v1/statistics/2024-03-20/{type}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": {},
    "timeFilter": [
      "SUNDAYS"
    ],
    "timeSpan": "ONE_DAY",
    "version": "2025.05.23.1",
    "enoughData": true,
    "metadata": {
      "appVersion": "2025.05.23.1",
      "platform": "ios"
    }
  }'

Responses

Bodyapplication/json
datestring(date-time)required
dataobjectrequired
typestringrequired
createdstring(date-time)required
lastUpdatedstring(date-time)required
timeFilterArray of stringsrequired
timeSpanstringrequired
enoughDatabooleanrequired
versionstringrequired
metadataobjectrequired
Response
application/json
{ "date": "2019-08-24T14:15:22Z", "data": {}, "type": "string", "created": "2019-08-24T14:15:22Z", "lastUpdated": "2019-08-24T14:15:22Z", "timeFilter": [ "string" ], "timeSpan": "string", "enoughData": true, "version": "string", "metadata": {} }

Request

For more information visit Statistics Context

Security
bearer
Path
datestring(date-time)required

Date in YYYY-MM-DD format

Example: 2024-03-20
typestringrequired
Enum"STRESS_DURATION""STRESS_RECOVERY""STRESS_FREQUENCY""INTENSE_ACTIVITY""DAYTIME_RESTING_HEART_RATE""SLEEP_HRV""SLEEP_DURATION""SLEEP_REGULARITY""SLEEP_STAGES""SLEEP_CYCLES"
curl -i -X DELETE \
  'https://docs.api.nowatch.tech/_mock/apis/v1/statistics/2024-03-20/{type}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
datestring(date-time)required
dataobjectrequired
typestringrequired
createdstring(date-time)required
lastUpdatedstring(date-time)required
timeFilterArray of stringsrequired
timeSpanstringrequired
enoughDatabooleanrequired
versionstringrequired
metadataobjectrequired
Response
application/json
{ "date": "2019-08-24T14:15:22Z", "data": {}, "type": "string", "created": "2019-08-24T14:15:22Z", "lastUpdated": "2019-08-24T14:15:22Z", "timeFilter": [ "string" ], "timeSpan": "string", "enoughData": true, "version": "string", "metadata": {} }

sharing

Manage sharing your data with other people

Operations

shared

Manage other people's data shared with you

Operations

telemetry

Application telemetry data (spans, metrics, logs)

Operations