List Activities

get

The List Activities (GET v1/me/sport/activities) endpoint provides a paginated list of summary details of the user's Activities, beginning with the most recent Activity. Activity information includes Activity ID, Activity Type, start time, status, device type, tags, and summary metric data (calories, fuel, distance, steps, and duration). The List Activities endpoint will always return a daily ALL_DAY Activity Type that has deduped NikeFuel across Activities in metricSummary.fuel (see NikeFuel Across Activities for more information about how to use the ALL_DAY Activity Type to provide deduped NikeFuel across Activities).

Note:  This endpoint does not return detailed metric data (e.g., interval unit, interval value, Metric Type, and metric values) for a user’s Activities. Use the Activity Detail endpoint to retrieve detailed metric data one Activity at a time.

Note:  This endpoint does not return GPS data. Use the GPS Data endpoint to retrieve GPS data one Activity at a time.

Test Console

Request

GEThttps://api.nike.com/v1/me/sport/activities

QUERY PARAMETERS

Name Type Required? Description
access_token String Yes User's access token
count Integer No Pagination: number of records to retrieve (default 5)
offset Integer No Pagination: first record to retrieve (starts at 1)
startDate String

No

(Yes if endDate is used)

Start date in ISO8601 standard format (yyyy-mm-dd) of the list of Activities. startDate is required if endDate (see below) is used.
endDate String

No

(Yes if startDate is used)

End date in ISO8601 standard format (yyyy-mm-dd) of the list of Activities. endDate is required if startDate i(see above) is used.

Sample Request

GET https://api.nike.com/v1/me/sport/activities?access_token={access_token}&count=10&startDate=2012-01-01&endDate=2014-02-15

Response

Response Body JSON Schema

RESPONSE BODY FIELDS

Distances and weights are returned in metric units (see Metric Types for more information). Dates and times are returned in UTC following ISO8601 standard formats.
Name Type Description
data Array of Objects
List of the user's Activities
data[n].links Array

List of links to related resources (see the HATEOAS page for more information)

data[n].activityId String
Unique Activity identifier
data[n].activityType
String
Type of Activity performed (see Activity Types for full list)
data[n].startTime
String
Start time of Activity in UTC standard ISO8601 format
data[n].activityTimeZone
String
Time zone name in which the Activity occurred. Nike+ supports political time zones found in the IANA Time Zone Database (e.g., “America/Los_Angeles”) and Etc/GMT offset (e.g., “Etc/GMT-8”).
data[n].status
String
Status of the Activity (NONE, IN_PROGRESS, or COMPLETED)
data[n].deviceType
String
Device used to record the Activity
data[n].metricSummary
Object
Object containing summary metric data for the Activity
metricSummary.calories String
Number of calories burned during the Activity
metricSummary.fuel String
Amount of NikeFuel gained during the Activity. If the Activity Type is the ALL_DAY Activity Type, then the value of metricSummary.fuel will be the deduped NikeFuel across Activities (see NikeFuel Across Activities for more information).
metricSummary.distance String
Distance traveled during the Activity
metricSummary.steps String
Number of steps taken during the Activity
metricSummary.duration String
The amount of time the Activity lasted in the format Hours:Minutes:Seconds.Milliseconds
data[n].tags
Array of Objects
Additional details the user entered about the Activity
tags[n].tagType
String
Type of tag
tags[n].tagValue
String
Value of the tag
data[n].metrics
Array of Objects
This will always be empty for this endpoint
paging Object Object that contains pagination links
paging.next String The request that will return the next page of Activities
paging.previous String The request that will return the previous page of Activities

Sample Response Body

{
    "data": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": " https://api.nike.com/v1/me/sport/activities/1456000000012581358940004583592943423568"
                }
            ],
            "activityId": "1456000000012581358940004583592943423568",
            "activityType": "RUN",
            "startTime": "2012-03-05T19:01:12Z",
            "activityTimeZone": "America/Los_Angeles",
            "status": "COMPLETE",
            "deviceType": "IPHONE",
            "metricSummary": {
                "calories": "250",
                "fuel": "4000",
                "distance": "9.5",
                "steps": "1000",
                "duration": "40:00:00.000"
            },
            "tags": [
                {
                    "tagType": "TERRAIN",
                    "tagValue": "TRAIL"
                },
                {
                    "tagType": "WEATHER",
                    "tagValue": "SUNNY"
                }
            ],
            "metrics": []
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": " https://api.nike.com/v1/me/sport/activities/2d4afde4-2329-4c0c-a218-6adff7b20fd7"
                }
            ],
            "activityId": "2d4afde4-2329-4c0c-a218-6adff7b20fd7",
            "activityType": "ALL_DAY",
            "startTime": "2012-03-05T08:00:00Z",
            "activityTimeZone": "America/Los_Angeles",
            "status": "IN_PROGRESS",
            "deviceType": "FUELBAND",
            "metricSummary": {
                "calories": "1320",
                "fuel": "4000",
                "distance": "10.488167762756348",
                "steps": "13320",
                "duration": "0:40:00.000"
            },
            "tags": [],
            "metrics": []
        }
    ],
    "paging": {
        "next": "/me/sport/activities?startDate=2011-01-01&endDate=2012-03-05&offset=6",
        "previous": null
    }
}

Error Codes

Please refer to Error Codes and Responses