activitytype
/api/activitytype/
List methods: get, post, patch
Detail methods: get, put, patch, delete
An activitytype allows a user to assign a more informative context to a range. By associating an activitytype with a range the user can describe what kind of activities occured during that period and may store specific, query-able data as activityattributevalues.
The using filter accepts a boolean and will return all the activitytypes
the current user is (or is not) using. 'False', 'false', 'f', and '0' are
interpreted as False, all other values are True.
Fields
- activityview:
-
Unicode string data. Ex: "Hello World"
This field may be null
- base:
-
The basic type of the activitytype used internally to determine how particular attributes and statistics are calculated. One of: sleep, rest, low, medium, high.
This field is required.
- category:
-
Unicode string data. Ex: "Hello World". Must be one of "sleep", "resting", "lifestyle", "running", "cycling", "general sports".
This field may be null
- default_metrics:
-
Comma separated list of metrics that are returned by default
This field may be blank
This field will default to: []
- description:
-
Unicode string data. Ex: "Hello World"
This field may be blank
This field will default to: '' (empty string)
- id:
-
The primary key for this resource. Integer data. Ex: 2673
This field is readonly.
- name:
-
Unicode string data. Ex: "Hello World"
This field is required.
- resource_uri:
-
The unique URI where the object resides.
This field is readonly.
- user:
-
A user. Maybe specified by URI, email, or ID. Using a URI is recommended.
This field may be null
Filtering Options
- base: exact, in
- category: exact, in
- id: exact, in, gt, gte, lt, lte, range
- show_all: exact
- user: exact, in, gt, gte, lt, lte, range
- using: exact
If provided (regardless of the value), system-only activities are included in the results.
Sorting Options
- id, user
© 2024 by Carré Technologies Inc.