Activities

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

GET /v1/timeline/events/activity/{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 1, max 7). Only applies to application/json cursor-based pagination.
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

Responses

200 OK

{
  "data": [
    {
      "start_datetime": "2024-04-01T10:00:00Z",
      "end_datetime": "2024-04-01T10:30:00Z",
      "type": "WALK",
      "origin": "AUTO_GENERATED"
    },
    {
      "start_datetime": "2024-04-01T14:00:00Z",
      "end_datetime": "2024-04-01T15:00:00Z",
      "type": "RUN",
      "origin": "AUTO_GENERATED"
    }
  ],
  "next_cursor": null
}

404 Not Found

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "No Activity for user between 2024-04-01 and 2024-04-02 found in database",
  "instance": "/v1/timeline/events/activity/YOUR_USER_ID",
  "code": "not_found",
  "request_id": "3a7b2c1d-..."
}

Example Request (JSON)

cURL

curl -X GET "https://research-api.nowatch.com/v1/timeline/events/activity/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 Request (CSV)

cURL

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

Activity Types

Type	Description
UNSPECIFIED	Activity type not determined
OTHER	Other unclassified activity
WALK	Walking
RUN	Running
CYCLE	Cycling
REST	Resting / stationary

Origin Values

Value	Description
AUTO_GENERATED	Detected automatically by the device
MANUAL	Manually logged by the user