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

Creates new sessions

Request

For extra context visit: Sessions Context

Security
bearer
Bodyapplication/jsonrequiredArray [
start_datetimestringrequired
end_datetimestring
typenumberrequired
Enum0123456789
infoobject(SessionInfoDto)required
info.​namestring
info.​notestring
info.​subjective_inputsArray of objects(SubjectiveInput)
info.​originnumber
Enum012345
info.​toolstring
]
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/session \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "start_datetime": "string",
      "end_datetime": "string",
      "type": 0,
      "info": {
        "name": "string",
        "note": "string",
        "subjective_inputs": [
          {
            "datetime": "string",
            "type": 0,
            "value": 0,
            "tag": 0,
            "note": "string"
          }
        ],
        "origin": 0,
        "tool": "string"
      }
    }
  ]'

Responses

Returns created session id list

Fetch all user sessions based on start and end date

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/session?start_date=string&end_date=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'shared-user: string'

Responses

Bodyapplication/jsonArray [
idstringrequired
startDatetimestring(date-time)required
endDatetimestring(date-time)required
createdstring(date-time)required
lastUpdatedstring(date-time)required
typenumberrequired
Enum0123456789
infoobject(SessionInfo)required
info.​namestringrequired
info.​notestringrequired
info.​subjectiveInputsArray of objects(SubjectiveInput)required
info.​subjectiveInputs[].​datetimestringrequired
info.​subjectiveInputs[].​typenumberrequired

The type of subjective input.

  • For SubjectiveInputType.DAY: Represents the "How was your day?" question. This question appears once each day, when the user opens the app after the theoretical end of the workday (between 5 p.m. and midnight).
  • For SubjectiveInputType.SLEEP: Represents the "How was your sleep?" question. This question appears once each day, when the user opens the app after the theoretical end of the night of sleep (between 4 a.m. and midday).
Enum0123456
info.​subjectiveInputs[].​valuenumberrequired

The value associated with the subjective input. For "How was your day?" and "How was your sleep?" questions, possible values are:

  • 1: Very bad
  • 2: Bad
  • 3: Okay
  • 4: Good
  • 5: Very good
info.​subjectiveInputs[].​tagnumberrequired

A tag associated with the subjective input. For day-feedback and feelings, this tag should be 0 and is not used.

info.​subjectiveInputs[].​notestring
info.​originnumberrequired
Enum012345
info.​toolDatastring
]
Response
application/json
[
  {
    "id": "string",
    "startDatetime": "2019-08-24T14:15:22Z",
    "endDatetime": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "type": 0,
    "info": { … }
  }
]

Fetch session

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/session/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'shared-user: string'

Responses

Bodyapplication/json
idstringrequired
startDatetimestring(date-time)required
endDatetimestring(date-time)required
createdstring(date-time)required
lastUpdatedstring(date-time)required
typenumberrequired
Enum0123456789
infoobject(SessionInfo)required
info.​namestringrequired
info.​notestringrequired
info.​subjectiveInputsArray of objects(SubjectiveInput)required
info.​subjectiveInputs[].​datetimestringrequired
info.​subjectiveInputs[].​typenumberrequired

The type of subjective input.

  • For SubjectiveInputType.DAY: Represents the "How was your day?" question. This question appears once each day, when the user opens the app after the theoretical end of the workday (between 5 p.m. and midnight).
  • For SubjectiveInputType.SLEEP: Represents the "How was your sleep?" question. This question appears once each day, when the user opens the app after the theoretical end of the night of sleep (between 4 a.m. and midday).
Enum0123456
info.​subjectiveInputs[].​valuenumberrequired

The value associated with the subjective input. For "How was your day?" and "How was your sleep?" questions, possible values are:

  • 1: Very bad
  • 2: Bad
  • 3: Okay
  • 4: Good
  • 5: Very good
info.​subjectiveInputs[].​tagnumberrequired

A tag associated with the subjective input. For day-feedback and feelings, this tag should be 0 and is not used.

info.​subjectiveInputs[].​notestring
info.​originnumberrequired
Enum012345
info.​toolDatastring
Response
application/json
{
  "id": "string",
  "startDatetime": "2019-08-24T14:15:22Z",
  "endDatetime": "2019-08-24T14:15:22Z",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "type": 0,
  "info": {
    "name": "string",
    "note": "string",
    "subjectiveInputs": [ … ],
    "origin": 0,
    "toolData": "string"
  }
}

Update session

Request

For extra context visit: Sessions Context

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
start_datetimestringrequired
end_datetimestring
typenumberrequired
Enum0123456789
infoobject(SessionInfoDto)required
info.​namestring
info.​notestring
info.​subjective_inputsArray of objects(SubjectiveInput)
info.​originnumber
Enum012345
info.​toolstring
curl -i -X PUT \
  'https://docs.api.nowatch.tech/_mock/apis/v1/session/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_datetime": "string",
    "end_datetime": "string",
    "type": 0,
    "info": {
      "name": "string",
      "note": "string",
      "subjective_inputs": [
        {
          "datetime": "string",
          "type": 0,
          "value": 0,
          "tag": 0,
          "note": "string"
        }
      ],
      "origin": 0,
      "tool": "string"
    }
  }'

Responses

Status: Success

Delete session

Request

For extra context visit: Sessions Context

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

Responses

Status: Success

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

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