Skip to content
/
Create data export

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

Export data

Request

Security
bearer
Query
start_daystringrequired

Start day (inclusive) in YYYY-MM-DD format

Example: start_day=2025-01-01
end_daystringrequired

End day (inclusive) in YYYY-MM-DD format

Example: end_day=2025-01-31
typesArray of strings

Comma-separated list of data types to export. If not provided, all data types will be exported.

encryptedUserIdsArray of strings

Optional array of encrypted user IDs to export data for. The requesting user must have sharing permissions with these users.

Example: encryptedUserIds=encrypted_user_id_1&encryptedUserIds=encrypted_user_id_2
curl -i -X GET \
  'https://docs.api.nowatch.tech/_mock/apis/v1/user/export?start_day=2025-01-01&end_day=2025-01-31&types=string&encryptedUserIds=encrypted_user_id_1%2Cencrypted_user_id_2' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Stream file download

Response
No content

Create data export

Request

Security
bearer
Query
start_daystringrequired

Start day (inclusive) in YYYY-MM-DD format

Example: start_day=2025-01-01
end_daystringrequired

End day (inclusive) in YYYY-MM-DD format

Example: end_day=2025-01-31
typesArray of strings

Comma-separated list of data types to export. If not provided, all data types will be exported.

encryptedUserIdsArray of strings

Optional array of encrypted user IDs to export data for. The requesting user must have sharing permissions with these users.

Example: encryptedUserIds=encrypted_user_id_1&encryptedUserIds=encrypted_user_id_2
curl -i -X POST \
  'https://docs.api.nowatch.tech/_mock/apis/v1/user/export/create?start_day=2025-01-01&end_day=2025-01-31&types=string&encryptedUserIds=encrypted_user_id_1%2Cencrypted_user_id_2' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Export created

Bodyapplication/json
any
Response
application/json
{
  "id": "uuid"
}

List data exports

Request

Security
bearer
curl -i -X GET \
  https://docs.api.nowatch.tech/_mock/apis/v1/user/export/list \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
Example: "uuid-1234"
userIdstringrequired
Example: "uuid-user-1234"
statusstringrequired
Enum"IN_PROGRESS""COMPLETED""FAILED"
Example: "IN_PROGRESS"
typesArray of arraysrequired
Example: ["TIMELINE_TIME-SERIES_HEART-RATE"]
exportedUserIdsArray of arraysrequired
Example: ["uid_1234"]
createdAtstring(date-time)required
Example: "2024-01-01T00:00:00.000Z"
updatedAtstring(date-time)required
Example: "2024-01-01T00:00:00.000Z"
]
Response
application/json
[
  {
    "id": "uuid-1234",
    "userId": "uuid-user-1234",
    "status": "IN_PROGRESS",
    "types": [ … ],
    "exportedUserIds": [ … ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]

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

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