Skip to content

NOWATCH API (0.9.0)

The NOWATCH API

Download OpenAPI description
index.json
index.yaml
Overview
Languages
Servers
Mock server

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

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

auth

User authentication

Operations

user

User data routes

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

session

Activity session tracking

Operations

checkin

User check-ins and wellness tracking

Operations

alarm

User alarm management

Operations

day-feedback

Daily feedback and mood tracking

Operations

sleep

Sleep logs and sleep data

Operations

activity

Sessions wrapper for activities

Operations

Creates a new activity

Request

For extra context visit: Sessions Context

Security
bearer
Bodyapplication/jsonrequired
start_datetimestringrequired
end_datetimestringrequired
typestringrequired
Enum"UNDEFINED""BREATHWORK""ICE_BATH""CYCLING""DANCING""EVENT""HIKING""MEDITATION""LISTENING_TO_MUSIC""PAINT"
originstringrequired
Enum"USER_GENERATED""AUTO_GENERATED""STARTED_OUTSIDE_APP""STOPPED_OUTSIDE_APP""STARTED_AND_STOPPED_OUTSIDE_APP""LOGGED_FROM_TIMELINE"
namestringrequired
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/activity \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_datetime": "string",
    "end_datetime": "string",
    "type": "UNDEFINED",
    "origin": "USER_GENERATED",
    "name": "string"
  }'

Responses

Returns created activity id

Fetch all activites for date range

Request

For extra context visit: Sessions Context

Security
bearer
Query
start_datestringrequired
end_datestringrequired
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/activity?start_date=string&end_date=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'shared-user: string'

Responses

Bodyapplication/jsonArray [
idstringrequired
startDatetimestring(date-time)required
typestringrequired
Enum"UNDEFINED""BREATHWORK""ICE_BATH""CYCLING""DANCING""EVENT""HIKING""MEDITATION""LISTENING_TO_MUSIC""PAINT"
endDatetimestring(date-time)required
namestringrequired
lastUpdatedstring(date-time)required
createdstring(date-time)required
originstringrequired
]
Response
application/json
[
  {
    "id": "string",
    "startDatetime": "2019-08-24T14:15:22Z",
    "type": "UNDEFINED",
    "endDatetime": "2019-08-24T14:15:22Z",
    "name": "string",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "origin": "string"
  }
]

Fetch activity by id

Request

For extra context visit: Sessions Context

Security
bearer
Path
idstringrequired
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/activity/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'shared-user: string'

Responses

Bodyapplication/jsonArray [
idstringrequired
startDatetimestring(date-time)required
typestringrequired
Enum"UNDEFINED""BREATHWORK""ICE_BATH""CYCLING""DANCING""EVENT""HIKING""MEDITATION""LISTENING_TO_MUSIC""PAINT"
endDatetimestring(date-time)required
namestringrequired
lastUpdatedstring(date-time)required
createdstring(date-time)required
originstringrequired
]
Response
application/json
[
  {
    "id": "string",
    "startDatetime": "2019-08-24T14:15:22Z",
    "type": "UNDEFINED",
    "endDatetime": "2019-08-24T14:15:22Z",
    "name": "string",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "origin": "string"
  }
]

Update activity

Request

For extra context visit: Sessions Context

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
start_datetimestringrequired
end_datetimestringrequired
typestringrequired
Enum"UNDEFINED""BREATHWORK""ICE_BATH""CYCLING""DANCING""EVENT""HIKING""MEDITATION""LISTENING_TO_MUSIC""PAINT"
namestringrequired
originstringrequired
Enum"USER_GENERATED""AUTO_GENERATED""STARTED_OUTSIDE_APP""STOPPED_OUTSIDE_APP""STARTED_AND_STOPPED_OUTSIDE_APP""LOGGED_FROM_TIMELINE"
curl -i -X PUT \
  'https://docs.api.nowatch.tech/_mock/apis/v1/activity/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_datetime": "string",
    "end_datetime": "string",
    "type": "UNDEFINED",
    "name": "string",
    "origin": "USER_GENERATED"
  }'

Responses

Status: Success

Delete a activity

Request

For extra context visit: Sessions Context

Security
bearer
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.api.nowatch.tech/_mock/apis/v1/activity/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Status: success

intention

Sessions wrapper for intentions

Operations

statistics

Aggregated health statistics

Operations

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