Activity Type
This resource provides access to Activity Types. Activity Types are commonly linked to other objects such as Routes and Workouts, and describe the activity.
Resource URIs
Item URI: /v7.1/activity_type/{id}/
Collection URI: /v7.1/activity_type/
Item
Item methods
GET
Retrieve a single Activity Type
by id
Item query parameters
None
Item properties
Name | Description | Type | Units | HTTP Support |
---|---|---|---|---|
import_only |
Indicates whether or not the Activity Type is only valid for imported workouts | Boolean | GET: Required | |
location_aware |
Indicates whether or not the Activity Type is valid for location or GPS-based activities | Boolean | GET: Required | |
name |
Name of the Activity Type | string | GET: Required | |
mets |
Standard METs for the Activity Type | string | GET: Required | |
mets_speed |
A mapping from speed to corresponding standard METs | number | GET: Required | |
short_name |
Short name of the Activity Type | string | GET: Required | |
has_children |
Indicates whether or not the Activity Type has children | Boolean | GET: Required | |
template |
A root-level attribute that holds parametrized template attributes specific to the activity type. | [template ][Template] |
GET: Required |
Template
Template attributes include terminology used in communication around an Activity Type(s).
Name | Description | Type |
---|---|---|
user_action_past |
Singular user performed Activity Type in the past | string |
user_action_present |
Singular user presently performing Activity Type | string |
activities_are |
Plural Activity Type as the subject with appropriate conjugated form of the verb, ‘to be’ | string |
Example values
user_action_past
Valid values are <user.name> did a gym workout
, <user.name> played tennis
user_action_present
Valid values are <user.name> is doing a gym workout
, <user.name> is playing tennis
activities_are
Valid values are snow skiing is
, treadmill runs are
Note: values will be returned for
user_action_past
anduser_action_present
, butactivites_are
may be null.
Item links
parent
The direct parent of the Activity Type
root
The root of the tree in which the Activity Type resides
icon_url
URL for the Activity Type icon
Collection
Collection methods
GET
Retrieve multiple Activity Types
Collection query parameters
None
Collection properties
Name | Description | Type | Units | HTTP Support |
---|---|---|---|---|
total_count |
the total number of Activity Types | int | GET: required |
Collection links
None
Embedded collections
activity_types
A collection of Activity Type items with properties as described under Item properties
and links as described under Item links
Usage
GET an Activity Type
by id
Request GET: /v7.1/activity_type/<id>/
Response 200
{
"mets": 8.0,
"mets_speed": [
{
"mets": "4",
"speed": 4.4704
},
{
"mets": "6",
"speed": 4.91744
},
{
"mets": "8",
"speed": 5.81152
},
{
"mets": "10",
"speed": 6.7056
},
{
"mets": "12",
"speed": 7.8232
},
{
"mets": "16",
"speed": 8.9408
}
],
"name": "Bike Ride",
"short_name": "ride",
"has_children": true,
"location_aware": true,
"template": {
"user_action_past": "{user.name} rode",
"user_action_present": "{user.name} is riding",
"plural_activity_is": "Bike Rides are"
},
"_links": {
"icon_url": [
{
"href": "http://static.mapmyfitness.com/d/website/activity_icons/bike.png"
}
],
"self": [
{
"href": "/v7.1/activity_type/11/",
"id": "11"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/Activity_Type"
}
],
"root": [
{
"href": "/v7.1/activity_type/11/",
"id": "11"
}
]
}
}
GET Activity Type collection
Request GET: /v7.1/activity_type/
Response 200
{
"_embedded": {
"activity_types": [
Many instances of the `Item` response structure
]
},
"_links": {
"self": [
{
"href": "/v7.1/activity_type/?"
}
],
"documentation": [
{
"href": "https://developer.mapmyfitness.com/docs/Activity_Type"
}
]
},
"total_count": 771
}