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

Upload users insight feedback

Request

Security
bearer
Bodyapplication/jsonrequiredArray [
app_versionstringrequired
datestringrequired
feedbackArray of objects(InsightFeedbackOptionsV2Dto)required
feedback[].​sectionstringrequired
feedback[].​optionsArray of stringsrequired
feedback[].​thumbUpbooleanrequired
instance_idstringrequired
test_buildbooleanrequired
]
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v2/insight/feedback \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "app_version": "string",
      "date": "string",
      "feedback": [
        {
          "section": "string",
          "options": [
            "string"
          ],
          "thumbUp": true
        }
      ],
      "instance_id": "string",
      "test_build": true
    }
  ]'

Responses

Create a reflection for the day or week

Request

Security
bearer
Headers
app-versionstringrequired
Bodyapplication/jsonrequired
time_formatstringrequired
today_triggersArray of stringsrequired
today_metricsobjectrequired
past_daily_metricsobjectrequired
past_triggersobjectrequired
previous_research_insight_idsArray of stringsrequired
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v2/insight \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'app-version: string' \
  -d '{
    "time_format": "string",
    "today_triggers": [
      "string"
    ],
    "today_metrics": {},
    "past_daily_metrics": {},
    "past_triggers": {},
    "previous_research_insight_ids": [
      "string"
    ]
  }'

Responses

Fetch reflection with instance id

Request

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

Responses

Bodyapplication/json
instanceIdstringrequired
executedAtstring(date-time)required
statestringrequired
Enum"STARTED""RUNNING""FAILED""COMPLETED"
datestring(date-time)required
inputobject
outputobject
stepstringrequired
Response
application/json
{
  "instanceId": "string",
  "executedAt": "2019-08-24T14:15:22Z",
  "state": "STARTED",
  "date": "2019-08-24T14:15:22Z",
  "input": {},
  "output": {},
  "step": "string"
}

Upload users insight feedbackDeprecated

Request

Security
bearer
Bodyapplication/jsonrequiredArray [
datestringrequired
feedbacksArray of objects(Feedback)required
feedbacks[].​optionsArray of stringsrequired
feedbacks[].​sectionstringrequired
feedbacks[].​thumbsUpbooleanrequired
responseobjectrequired
app_versionstringrequired
]
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/insight/feedback \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "date": "string",
      "feedbacks": [
        {
          "options": [
            "string"
          ],
          "section": "string",
          "thumbsUp": true
        }
      ],
      "response": {},
      "app_version": "string"
    }
  ]'

Responses

Create a reflection for the day or weekDeprecated

Request

Security
bearer
Headers
app-versionstringrequired
Bodyapplication/jsonrequired
typestringrequired
Enum"daily""weekly"
platformstringrequired
app_versionstringrequired
date_of_reportstringrequired
topic_of_intereststringrequired
verbositynumberrequired
style_modifiersobject(StyleModifiersDto)required
style_modifiers.​xaxnumberrequired
style_modifiers.​yaxnumberrequired
previous_vdb_idsobject(PreviousVdbIdsDto)required
previous_vdb_ids.​previously_usedArray of stringsrequired
previous_vdb_ids.​likedArray of stringsrequired
previous_vdb_ids.​dislikedArray of stringsrequired
personal_pinsArray of stringsrequired
historystringrequired
day_level_eventsArray of stringsrequired
qualitative_summaryArray of objects(QualitativeSummaryDayDto)required
qualitative_summary[].​daystringrequired
qualitative_summary[].​eventsArray of stringsrequired
qualitative_summary[].​trendsArray of stringsrequired
qualitative_summary[].​historystringrequired
qualitative_summary[].​day_level_eventsArray of stringsrequired
quantitative_summaryobject(QuantitativeSummaryDto)required
quantitative_summary.​outliersArray of stringsrequired
quantitative_summary.​compared_to_typicalArray of stringsrequired
quantitative_summary.​compared_to_previousArray of stringsrequired
curl -i -X POST \
  https://docs.api.nowatch.tech/_mock/apis/v1/insight \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'app-version: string' \
  -d '{
    "type": "daily",
    "platform": "string",
    "app_version": "string",
    "date_of_report": "string",
    "topic_of_interest": "string",
    "verbosity": 0,
    "style_modifiers": {
      "xax": 0,
      "yax": 0
    },
    "previous_vdb_ids": {
      "previously_used": [
        "string"
      ],
      "liked": [
        "string"
      ],
      "disliked": [
        "string"
      ]
    },
    "personal_pins": [
      "string"
    ],
    "history": "string",
    "day_level_events": [
      "string"
    ],
    "qualitative_summary": [
      {
        "day": "string",
        "events": [
          "string"
        ],
        "trends": [
          "string"
        ],
        "history": "string",
        "day_level_events": [
          "string"
        ]
      }
    ],
    "quantitative_summary": {
      "outliers": [
        "string"
      ],
      "compared_to_typical": [
        "string"
      ],
      "compared_to_previous": [
        "string"
      ]
    }
  }'

Responses

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