Check-ins

The Check-ins endpoint provides access to check-in events logged via the NOWATCH app or a crown press.

GET /v1/timeline/events/checkins/{user_id}

Parameters

Name	Type	In	Description
`user_id`	UUID	Path	The unique identifier for the user.
`start_date`	Date	Query	The start date for the query period (format: `YYYY-MM-DD`).
`end_date`	Date	Query	The end date for the query period (format: `YYYY-MM-DD`).
`days`	Integer	Query	Days per page (default `7`, max `30`). Only applies to `application/json` cursor-based pagination — `text/csv` ignores `days` and returns the whole requested range in one response.
`cursor`	String	Query	Pagination cursor from the previous response. Only supported on `application/json`; returns `400` for CSV.

Response Formats

Header Value	Format
`application/json`	JSON (default)
`text/csv`	CSV

Response Status Codes

200 ok

The request was successful. A date range with no data returns 200 with an empty data array.

400 bad request

An invalid cursor was supplied, or cursor was combined with text/csv.

406 not acceptable

An unsupported Accept header was requested.

See Errors for authentication, validation, and rate-limit responses.

Example Request (JSON)

cURL

curl -X GET "https://research-api.nowatch.com/v1/timeline/events/checkins/YOUR_USER_ID?start_date=2024-04-01&end_date=2024-04-02" \
  -H "accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"

Example Response

200 OK

{
  "data": [
    {
      "datetime": "2024-04-01T12:00:00.000Z",
      "origin": "CROWN_PRESS",
      "reactivity": "CENTERED",
      "valence": "NEUTRAL",
      "related_feelings": ["HAPPY", "MOTIVATED"],
      "context": ["WORKING", "MEETING"]
    }
  ],
  "next_cursor": null
}

Example Request (CSV)

cURL

curl -X GET "https://research-api.nowatch.com/v1/timeline/events/checkins/YOUR_USER_ID?start_date=2024-04-01&end_date=2024-04-02" \
  -H "accept: text/csv" \
  -H "X-API-KEY: YOUR_API_KEY"

Example Response (CSV)

200 OK

datetime,origin,reactivity,valence,related_feelings,context
2024-04-01T12:00:00.000Z,CROWN_PRESS,CENTERED,NEUTRAL,HAPPY;MOTIVATED,WORKING;MEETING

Note

In CSV, the multi-value fields related_feelings and context are semicolon-separated within a single cell (e.g. HAPPY;MOTIVATED). An empty list is an empty cell.