Skip to content

Activities

The Activities endpoint provides access to detected activity sessions (walks, runs, cycles, etc.).

GET /v1/timeline/events/activities/{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/activities/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": [
    {
      "start_datetime": "2024-04-01T10:00:00.000Z",
      "end_datetime": "2024-04-01T10:30:00.000Z",
      "type": "WALKING",
      "origin": "AUTO"
    },
    {
      "start_datetime": "2024-04-01T14:00:00.000Z",
      "end_datetime": "2024-04-01T15:00:00.000Z",
      "type": "YOGA",
      "origin": "MANUAL"
    }
  ],
  "next_cursor": null
}

Example Request (CSV)

cURL
curl -X GET "https://research-api.nowatch.com/v1/timeline/events/activities/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
start_datetime,end_datetime,type,origin
2024-04-01T10:00:00.000Z,2024-04-01T10:30:00.000Z,WALKING,AUTO
2024-04-01T14:00:00.000Z,2024-04-01T15:00:00.000Z,YOGA,MANUAL

Activity Types

type is one of a large set of activity tags (over 100 values). The device auto-detects three of them; the rest are produced when a user manually logs an activity.

Type Description
WALKING Auto-detected walking
RUN Auto-detected running
CYCLING Auto-detected cycling
Manually logged tags (e.g. YOGA, FOOTBALL, MEDITATION, WORKOUT, SWIMMING, READING, …)

The complete, authoritative list of values is the type enum in the OpenAPI spec.

Origin Values

Value Description
AUTO Auto-detected by the device
MANUAL Logged by the user