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

Fetches a single sleep log for a user

Request

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

Responses

Bodyapplication/json
idstringrequired
start_datetimestring(date-time)required
end_datetimestring(date-time)required
userIdstringrequired
originnumber
Enum01
detailsArray of numbers
Items Enum-101234
confirmednumber
Enum0123
awakeningsArray of objects(SleepAwakening)
modified_start_datetimestring(date-time)
modified_end_datetimestring(date-time)
Response
application/json
{
  "id": "string",
  "start_datetime": "2019-08-24T14:15:22Z",
  "end_datetime": "2019-08-24T14:15:22Z",
  "userId": "string",
  "origin": 0,
  "details": [
    -1
  ],
  "confirmed": 0,
  "awakenings": [
    { … }
  ],
  "modified_start_datetime": "2019-08-24T14:15:22Z",
  "modified_end_datetime": "2019-08-24T14:15:22Z"
}

Update a sleep log for a user

Request

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
start_datetimestringrequired
end_datetimestringrequired
originnumber

AUTO (0), USER (1)

Enum01
detailsArray of numbers

[UNKNOWN (-1), NAP (0), SLEPT_ENOUGH (1), RESTLESS_SLEEP (2), WOKE_UP_TIRED (3), WOKE_UP_ENERGISED (4)]

Items Enum-101234
confirmednumber

NO_CHANGE (0), DELETED (1), CONFIRMED (2), MODIFIED (3)

Enum0123
awakeningsArray of objects(SleepAwakeningsDto)
modified_start_datetimestring
modified_end_datetimestring
curl -i -X PUT \
  'https://docs.api.nowatch.tech/_mock/apis/v1/sleep/log/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_datetime": "string",
    "end_datetime": "string",
    "origin": 0,
    "details": [
      -1
    ],
    "confirmed": 0,
    "awakenings": [
      {
        "start_datetime": "string",
        "end_datetime": "string",
        "origin": 0,
        "modified_start_datetime": "string",
        "modified_end_datetime": "string"
      }
    ],
    "modified_start_datetime": "string",
    "modified_end_datetime": "string"
  }'

Responses

Status: Success

Delete a sleep log for a user

Request

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

Responses

Status: Success

Fetches all sleep logs for a user

Request

Security
bearer
Query
start_datestringrequired
end_datestringrequired
curl -i -X GET \
  'https://docs.api.nowatch.tech/_mock/apis/v1/sleep/log?start_date=string&end_date=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
start_datetimestring(date-time)required
end_datetimestring(date-time)required
userIdstringrequired
originnumber
Enum01
detailsArray of numbers
Items Enum-101234
confirmednumber
Enum0123
awakeningsArray of objects(SleepAwakening)
modified_start_datetimestring(date-time)
modified_end_datetimestring(date-time)
]
Response
application/json
[
  {
    "id": "string",
    "start_datetime": "2019-08-24T14:15:22Z",
    "end_datetime": "2019-08-24T14:15:22Z",
    "userId": "string",
    "origin": 0,
    "details": [ … ],
    "confirmed": 0,
    "awakenings": [ … ],
    "modified_start_datetime": "2019-08-24T14:15:22Z",
    "modified_end_datetime": "2019-08-24T14:15:22Z"
  }
]

Create a sleep log for a user

Request

Security
bearer
Bodyapplication/jsonrequired
sleep_logsArray of objects(SleepLogDto)required
sleep_logs[].​start_datetimestringrequired
sleep_logs[].​end_datetimestringrequired
sleep_logs[].​originnumber

AUTO (0), USER (1)

Enum01
sleep_logs[].​detailsArray of numbers

[UNKNOWN (-1), NAP (0), SLEPT_ENOUGH (1), RESTLESS_SLEEP (2), WOKE_UP_TIRED (3), WOKE_UP_ENERGISED (4)]

Items Enum-101234
sleep_logs[].​confirmednumber

NO_CHANGE (0), DELETED (1), CONFIRMED (2), MODIFIED (3)

Enum0123
sleep_logs[].​awakeningsArray of objects(SleepAwakeningsDto)
sleep_logs[].​modified_start_datetimestring
sleep_logs[].​modified_end_datetimestring
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/sleep/log \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sleep_logs": [
      {
        "start_datetime": "string",
        "end_datetime": "string",
        "origin": 0,
        "details": [
          -1
        ],
        "confirmed": 0,
        "awakenings": [
          {
            "start_datetime": "string",
            "end_datetime": "string",
            "origin": 0,
            "modified_start_datetime": "string",
            "modified_end_datetime": "string"
          }
        ],
        "modified_start_datetime": "string",
        "modified_end_datetime": "string"
      }
    ]
  }'

Responses

Sleep log created, returns array of created Ids

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

Fetches all processed sleep records for a user

Request

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

Responses

Bodyapplication/jsonArray [
idstringrequired
originnumberrequired
Enum-101234
confirmed_typenumberrequired
Enum-10123
created_atstring(date-time)required
start_datetimestring(date-time)required
end_datetimestring(date-time)required
details_dataArray of numbers
stagesArray of objects
source_idsArray of strings
metadataobjectrequired
]
Response
application/json
[
  {
    "id": "string",
    "origin": -1,
    "confirmed_type": -1,
    "created_at": "2019-08-24T14:15:22Z",
    "start_datetime": "2019-08-24T14:15:22Z",
    "end_datetime": "2019-08-24T14:15:22Z",
    "details_data": [ … ],
    "stages": [ … ],
    "source_ids": [ … ],
    "metadata": {}
  }
]

Fetches a single sleep record for a user

Request

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

Responses

Bodyapplication/json
idstringrequired
originnumberrequired
Enum-101234
confirmed_typenumberrequired
Enum-10123
created_atstring(date-time)required
start_datetimestring(date-time)required
end_datetimestring(date-time)required
details_dataArray of numbers
stagesArray of objects
source_idsArray of strings
metadataobjectrequired
Response
application/json
{
  "id": "string",
  "origin": -1,
  "confirmed_type": -1,
  "created_at": "2019-08-24T14:15:22Z",
  "start_datetime": "2019-08-24T14:15:22Z",
  "end_datetime": "2019-08-24T14:15:22Z",
  "details_data": [
    0
  ],
  "stages": [
    {}
  ],
  "source_ids": [
    "string"
  ],
  "metadata": {}
}

Update or create a sleep record for a user

Request

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
idstringrequired
originnumberrequired
Enum-101234
confirmed_typenumberrequired
Enum-10123
created_atstring(date-time)required
start_datetimestring(date-time)required
end_datetimestring(date-time)required
details_dataArray of numbers
stagesArray of objects(SleepStageDto)
source_idsArray of strings
metadataobject(SleepMetadataDto)required
metadata.​app_versionstringrequired
metadata.​algorithm_versionstringrequired
metadata.​platformstringrequired
curl -i -X PUT \
  'https://docs.api.nowatch.tech/_mock/apis/v2/sleep/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "origin": -1,
    "confirmed_type": -1,
    "created_at": "2019-08-24T14:15:22Z",
    "start_datetime": "2019-08-24T14:15:22Z",
    "end_datetime": "2019-08-24T14:15:22Z",
    "details_data": [
      0
    ],
    "stages": [
      {
        "id": "string",
        "start_datetime": "2019-08-24T14:15:22Z",
        "end_datetime": "2019-08-24T14:15:22Z",
        "type": 0
      }
    ],
    "source_ids": [
      "string"
    ],
    "metadata": {
      "app_version": "string",
      "algorithm_version": "string",
      "platform": "string"
    }
  }'

Responses

Returns the id of the updated or created sleep record

Bodyapplication/json
string
Response
application/json
"string"

Delete sleep record for user

Request

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

Responses

Status: Success

Fetches all sleep records for a user

Request

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

Responses

Bodyapplication/jsonArray [
idstringrequired
originnumberrequired
Enum-101234
confirmed_typenumberrequired
Enum-10123
created_atstring(date-time)required
start_datetimestring(date-time)required
end_datetimestring(date-time)required
details_dataArray of numbers
stagesArray of objects
source_idsArray of strings
metadataobjectrequired
]
Response
application/json
[
  {
    "id": "string",
    "origin": -1,
    "confirmed_type": -1,
    "created_at": "2019-08-24T14:15:22Z",
    "start_datetime": "2019-08-24T14:15:22Z",
    "end_datetime": "2019-08-24T14:15:22Z",
    "details_data": [ … ],
    "stages": [ … ],
    "source_ids": [ … ],
    "metadata": {}
  }
]

Create sleep record for a user

Request

Security
bearer
Bodyapplication/jsonrequired
sleepsArray of objects(SleepDto)required
sleeps[].​idstringrequired
sleeps[].​originnumberrequired
Enum-101234
sleeps[].​confirmed_typenumberrequired
Enum-10123
sleeps[].​created_atstring(date-time)required
sleeps[].​start_datetimestring(date-time)required
sleeps[].​end_datetimestring(date-time)required
sleeps[].​details_dataArray of numbers
sleeps[].​stagesArray of objects(SleepStageDto)
sleeps[].​source_idsArray of strings
sleeps[].​metadataobject(SleepMetadataDto)required
sleeps[].​metadata.​app_versionstringrequired
sleeps[].​metadata.​algorithm_versionstringrequired
sleeps[].​metadata.​platformstringrequired
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v2/sleep \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sleeps": [
      {
        "id": "string",
        "origin": -1,
        "confirmed_type": -1,
        "created_at": "2019-08-24T14:15:22Z",
        "start_datetime": "2019-08-24T14:15:22Z",
        "end_datetime": "2019-08-24T14:15:22Z",
        "details_data": [
          0
        ],
        "stages": [
          {
            "id": "string",
            "start_datetime": "2019-08-24T14:15:22Z",
            "end_datetime": "2019-08-24T14:15:22Z",
            "type": 0
          }
        ],
        "source_ids": [
          "string"
        ],
        "metadata": {
          "app_version": "string",
          "algorithm_version": "string",
          "platform": "string"
        }
      }
    ]
  }'

Responses

Sleep record created

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

Update or create multiple sleep records for a user

Request

Security
bearer
Bodyapplication/jsonrequired
sleepsArray of objects(SleepDto)required
sleeps[].​idstringrequired
sleeps[].​originnumberrequired
Enum-101234
sleeps[].​confirmed_typenumberrequired
Enum-10123
sleeps[].​created_atstring(date-time)required
sleeps[].​start_datetimestring(date-time)required
sleeps[].​end_datetimestring(date-time)required
sleeps[].​details_dataArray of numbers
sleeps[].​stagesArray of objects(SleepStageDto)
sleeps[].​source_idsArray of strings
sleeps[].​metadataobject(SleepMetadataDto)required
sleeps[].​metadata.​app_versionstringrequired
sleeps[].​metadata.​algorithm_versionstringrequired
sleeps[].​metadata.​platformstringrequired
curl -i -X PUT \
  https://docs.api.nowatch.tech/_mock/apis/v2/sleep/batch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sleeps": [
      {
        "id": "string",
        "origin": -1,
        "confirmed_type": -1,
        "created_at": "2019-08-24T14:15:22Z",
        "start_datetime": "2019-08-24T14:15:22Z",
        "end_datetime": "2019-08-24T14:15:22Z",
        "details_data": [
          0
        ],
        "stages": [
          {
            "id": "string",
            "start_datetime": "2019-08-24T14:15:22Z",
            "end_datetime": "2019-08-24T14:15:22Z",
            "type": 0
          }
        ],
        "source_ids": [
          "string"
        ],
        "metadata": {
          "app_version": "string",
          "algorithm_version": "string",
          "platform": "string"
        }
      }
    ]
  }'

Responses

Returns the ids of the updated or created sleep records

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

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