API Description

An API to serve 3 key concepts for quantified self

Sport activity tracking
Body measures
Personal statistics

Main benefits

A Framework to structure sport activities
Algorithm to calculate Kcal, elevation
The sport data consolidated around you
The flexibility to manage many sports (running to tennis...)
Persistence of your data

Global vision

Opening to the world the connected sport
Embracing diversity
Nurturing the sport practice ecosystem # Get started

API for quantified self and connected products : Sport activities, statistics & body measures

API conventions

All data is sent and received as JSONLD

Date format : 2013-03-09T16:39:53+00:00

Date filter : ?property[after|before|strictly_after|strictly_before]=value Example : createdAt[after]=2018-03-19

Country codes follow the is norme ISO 3166 with 2 char ( ex : FR)

Language codes follow the norme ISO 639-1 with 2 char ( ex : NL)

API Registration

Our self service developer portal is not yet ready. First contact infra@decathloncoach.com with information :

name of your application
purpose of your application
an url for the callback Oauthv2 flow authorization code
a logo of your application

If we validate your application, you will receive :

an api key
a client ID and secret for login

Swagger

You can find a Swagger UI here.

Authentification

Sports Tracking Data is a ressource server, the identification and authorization role is assumed by Geonaute Account (it will be replaced during 2019 by Decathlon Login). Geonaute Account supports Oauth V2.

Flow supported :

Code flow

To get a client ID, contact infra@decathloncoach.com

Create a login button with this link:

https://account.geonaute.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=https://YOUR_REDIRECT_URL

After the user login, the user will be redirected to :

https://YOUR_REDIRECT_URL?code=XXXXXXXXXX

Collect the code on your server side and validate it with :

curl -X GET \
  'https://account.geonaute.com/oauth/accessToken?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URL&client_secret=CLIENT_ID_SECRET&code=THE_USER_CODE&grant_type=authorization_code'

You will receive an access_token in return :

{
  'access_token' : 'XXXXXXXXX'
}

Get JWT bearer

With the Access token you could get a JWT bearer with a validity of 15 minutes. This bearer will be required for almost all API calls to Sports Tracking Data.

curl -X GET \
  'https://account.geonaute.com/api/me?access_token=ACCESS_TOKEN'

Answer

{
    "email": "arthur@dent.com",
    "firstName": "Arthur",
    "gender": "male",
    "birthdate": 631238400000,
    "lastName": "Dent",
    "created": 1469717300448,
    "ldid": "HERE_THE_UNIQ_ID_FOR_SPORTS_TRACKING_DATA",
    "requestKey": "HERE_THE_JWT_bearer"
}

JWT payload structure

{
  "iss": "account.geonaute.com",
  "exp": 1504793223,
  "iat": 1504789623,
  "ldid": "dfdc03c5bXXXX",
  "stack": "eu1",
  "firstname": "Arthur",
  "lastname": "Dent",
  "email": "arthur@dent.com",
  "gender": "Male",
  "birthdate": "1990-01-01",
  "country": "FR"
}

Note the ldid field which is the Sports Tracling Data identification. It will serve in a lot of api calls as parameter.

Main operations

The main API operations are :

Get activities .
Post activity

The first call

GET https://api.decathlon.net/sportstrackingdata/v2/me/

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/me/ \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \

Sample answer

{
    "@context": "/v2/contexts/User",
    "@id": "/v2/users/ed3a20dfabaa09ae73f6",
    "@type": "User",
    "id": "ed3a20dfabaa09ae73f6",
    "oneId": null,
    "gender": 1,
    "roles": [
        "ROLE_USER"
    ],
    "language": "fr",
    "country": "BE",
    "imageUrl": "https://d1v3pubopekoj.cloudfront.net/prod/people/f0f31a5a71584076c6.png",
    "birthDate": "1984-07-27",
    "createdAt": "2013-03-09T16:39:53+00:00",
    "updatedAt": "2017-12-18T09:43:43+00:00",
    "scheduleDelete": null
}

Congratulations ! You executed your first request to know your basic settings of you user account. Now you will be able to add sport activities and get them by API.

Referentials

Sports Tracking Data supports many sports, many units to analyse sport activities and user's measures. To allow this, Sports Tracking Data uses a lot of abstraction. It permits to add a new sport or a new unit in a referential, then the new item is usable for everyone.

This is the list of the referentials :

Main referentials

Datatype
Sport

Each time you refer to a sport, you have to indicate the ressource id which refers to the referential. Example, if you create a new sport activity for an user, you will indicate the sport "/v2/sports/121" which refers to the Running. In same manner, Datatype is the referential of each units and measures of Sports Data. Example : Distance, Duration, Speed Current, Speed average, Speed max, elevation, body weight, body height...

Example with Sport referential

A referential is read only. If you have a request to add a new item please contact the support.

GET https://api.decathlon.net/sportstrackingdata/v2/sports

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/sports?active=1&page=1 \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \

Response

status 200 :  OK
{
    "@context": "/v2/contexts/Sport",
    "@id": "/v2/sports",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/sports/7",
            "@type": "Sport",
            "id": 7,
            "translatedNames": {
                "de": "Gleitschirmfliegen",
                "en": "Paragliding",
                "es": "Parapente",
                "fr": "Parapente",
                "hu": "Siklóernyős",
                "it": "Parapendio",
                "nl": "Paragliding",
                "pl": "Paralotniarstwo",
                "pt": "Parapente",
                "ru": "Параплан",
                "zh": "滑翔伞"
            },
            "universe": "/v2/universes/1",
            "active": true,
            "createdAt": "2018-03-14T13:09:00+00:00",
            "updatedAt": "2018-08-10T04:00:07+00:00"
        },
        {
            "@id": "/v2/sports/10",
            "@type": "Sport",
            "id": 10,
            "translatedNames": {
                "de": "Basketball",
                "en": "Basketball",
                "es": "Baloncesto",
                "fr": "Basketball",
                "hu": "Kosárlabda",
                "it": "Basket",
                "nl": "Basketbal",
                "pl": "Koszykówka",
                "pt": "Basquetebol",
                "ru": "Баскетбол",
                "zh": "篮球"
            },
            "universe": "/v2/universes/2",
            "active": true,
            "createdAt": "2018-03-14T13:09:00+00:00",
            "updatedAt": "2018-08-10T04:00:07+00:00"
        },
        {
            "@id": "/v2/sports/13",
            "@type": "Sport",
            "id": 13,
            "translatedNames": {
                "de": "Fußball",
                "en": "Football",
                "es": "Fútbol",
                "fr": "Football",
                "hu": "Labdarúgás",
                "it": "Calcio",
                "nl": "Voetbal",
                "pl": "Piłka nożna",
                "pt": "Futebol",
                "ru": "Футбол",
                "zh": "足球"
            },
            "universe": "/v2/universes/2",
            "active": true,
            "createdAt": "2018-03-14T13:09:00+00:00",
            "updatedAt": "2018-08-10T04:00:08+00:00"
        },
        {
            "@id": "/v2/sports/18",
            "@type": "Sport",
            "id": 18,
            "translatedNames": {
                "de": "Handball",
                "en": "Handball",
                "es": "Balonmano",
                "fr": "Handball",
                "hu": "Kézilabda",
                "it": "Pallamano",
                "nl": "Handbal",
                "pl": "Piłka ręczna",
                "pt": "Andebol",
                "ru": "Гандбол",
                "zh": "手球"
            },
            "universe": "/v2/universes/2",
            "active": true,
            "createdAt": "2018-03-14T13:09:00+00:00",
            "updatedAt": "2018-08-10T04:00:08+00:00"
        },
        {
            "@id": "/v2/sports/20",
            "@type": "Sport",
            "id": 20,
            "translatedNames": {
                "de": "Hockey",
                "en": "Hockey",
                "es": "Hockey",
                "fr": "Hockey",
                "hu": "Jéghoki",
                "it": "Hockey",
                "nl": "Hockey",
                "pl": "Hokej",
                "pt": "Hóquei",
                "ru": "Хоккей",
                "zh": "曲棍球"
            },
            "universe": "/v2/universes/2",
            "active": true,
            "createdAt": "2018-03-14T13:09:00+00:00",
            "updatedAt": "2018-08-10T04:00:08+00:00"
        },
        ...
           ],
    "hydra:view": {
        "@id": "/v2/sports?active=1&page=1",
        "@type": "hydra:PartialCollectionView",
        "hydra:next": "/v2/sports?active=1&page=2"
    },
    "hydra:search": {
        "@type": "hydra:IriTemplate",
        "hydra:template": "/v2/sports{?active}",
        "hydra:variableRepresentation": "BasicRepresentation",
        "hydra:mapping": [
            {
                "@type": "IriTemplateMapping",
                "variable": "active",
                "property": "active",
                "required": false
            }
        ]
    }
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Connected products referentials

Brand
DeviceModel
Firmware
Connector

These referentials are linked to the Decathlon connected products. They allow to manage the devices and get a traceability of the model and the firmwares used.

Other referentials

PoiCategory : list the different categories to classify a Point of Interest
StorageKey : list the different key allowed to store some data
Universe : list the universes to classify the different sports

Create a device

To create a sport activity, you have two manners to declare it :

manual creation : useful for an activity created by a form or a third app.
With a device and a connector : Useful for an activity created by a Decathlon product to allow the traceability

This page shows you how to create a new device for an user.

Request

POST https://api.decathlon.net/sportstrackingdata/v2/user_devices

Request body json { "serial": "serialnumber123456", "model": "/v2/device_models/1", "firmware": "/v2/firmwares/1", "user": "/v2/users/{{ldid}}", "ownership": 0, "lastConnectedAt": "2018-04-16T16:05:11.896Z" }

You will need to indicated some URI ressources to create a new device :

model refers to an URI of the DeviceModel Referential
firmware refers to an URI of the Firmware Referential
user refers to the URI of your user

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/user_devices \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
  "serial": "serialnumber123456",
  "model": "/v2/device_models/1",
  "firmware": "/v2/firmwares/1",
  "user": "/v2/users/{{ldid}}",
  "ownership": 0,
  "lastConnectedAt": "2018-04-16T16:05:11.896Z"
  }'

Response

status 201 : Created
{
    "@context": "/v2/contexts/UserDevice",
    "@id": "/v2/user_devices/eu271ed863164e25fb3d",
    "@type": "UserDevice",
    "id": "eu271ed863164e25fb3d",
    "serial": "serialnumber123456",
    "model": "/v2/device_models/1",
    "firmware": "/v2/firmwares/1",
    "user": "/v2/users/820d0a384a7013997f69",
    "ownership": 0,
    "lastConnectedAt": "2018-04-16T16:05:11+00:00",
    "createdAt": "2018-08-17T09:35:13+00:00",
    "updatedAt": "2018-08-17T09:35:13+00:00"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Thank to the new device URI : "/v2/user_devices/eu271ed863164e25fb3d" you will be able to create a new sport activity linked to this device.

Please refer to the swagger to see how to list all devices for an user, how to update a device for example if the firmware is updated.

Serial number of the device

Generally, the serial come from :

the real serial number of the product (ex: 1CD2071D-1440-4E5F-8C23-446D3B9B )
on the smartphones , a string composed by the os and the ldid (ex : androidapp-e615fb7b-839a-4e65-98)

We recommend these characters : a-z A-Z 0-9 -

Memo : why the device management is important

each device is unique with its serial number
each device could have specific configuration and settings (with user_device_setting)
each device is linked to a model id (=> check the product of the user)
each device is linked to a firmware (=> check the software of the product)

=> So it is important for troubleshooting when a problem occurs.

Retreive activities

Get the collection of activities.

Request

GET https://api.decathlon.net/sportstrackingdata/v2/activities

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/activities \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \

Response

status 200 : Ok
{
    "@context": "/v2/contexts/Activity",
    "@id": "/v2/activities",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/activities/eu205bc29d9975f27cfb",
            "@type": "Activity",
            "id": "eu205bc29d9975f27cfb",
            "name": "Test V2 - Android - 21 juin 2018",
            "user": "/v2/users/ed3a20dfabaf09ae73f6",
            "sport": "/v2/sports/381",
            "userDevice": null,
            "startdate": "2018-06-21T09:36:03+02:00",
            "duration": 753,
            "latitude": null,
            "longitude": null,
            "elevation": null,
            "manual": true,
            "comment": null,
            "connector": null,
            "userSession": null,
            "correctedElevation": true,
            "images": [],
            "thumbnail": "https://linkdata-ressources-eu2.geonaute.com/prod/ed3a20dfabaf09ae73f6/maps/eu205bc29d9975f27cfb.png",
            "dataSummaries": {
                "5": 4127,
                "9": 19731,
                "15": 42,
                "16": 25,
                "18": 17,
                "19": 1,
                "23": 117,
                "24": 753,
                "97": 70,
                "99": 70
            },
            "tags": [],
            "trackFlag": true,
            "datastreamFlag": true,
            "globalChallenge": null,
            "availableDatatypes": [
                5,
                9,
                23,
                24,
                97,
                99,
                6,
                14
            ],
            "createdAt": "2018-06-21T08:35:36+00:00",
            "updatedAt": "2018-06-21T08:35:38+00:00"
        }
    ],
    "hydra:view": {
        "@id": "/v2/activities?limit=2&page=1",
        "@type": "hydra:PartialCollectionView",
        "hydra:next": "/v2/activities?limit=2&page=2"
    },
    "hydra:search": {
        "@type": "hydra:IriTemplate",
        "hydra:template": "/v2/activities{?user,user[]}",
        "hydra:variableRepresentation": "BasicRepresentation",
        "hydra:mapping": [
            {
                "@type": "IriTemplateMapping",
                "variable": "user",
                "property": "user",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "user[]",
                "property": "user",
                "required": false
            }
        ]
    }
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Filters

You could apply many filter on this request, for example an interval of date, a sport id, ...

Add an activity

Add a sport activity to your account

Request

POST https://api.decathlon.net/sportstrackingdata/v2/activities

Request Body

To construct the body of our activity, you will need to describe the activity, name, startdate and furnhish some nodes of data :

dataSummaries : The consolidated values of your activity like the average speed, the length, the distance... (required)
datastream : The curves of values (speed, heartrate, ...) (optional)
locations : the GPS track (optional)

{
    "name":"My workout",
    "startdate":"2018-04-19T08:28:49+02:00",
    "duration":954,
    "user":"/v2/users/{{ldid}}",
    "sport":"/v2/sports/381",
    "connector":"/v2/connectors/702",
    "location":{
    "elapsed_time":0,
    "latitude":50.638437762,
    "longitude":3.125975041,
    "elevation":0,
    "device":{
        "firmware":59,
        "model":17,
        "sn":"androidapp-f72c681e8442049956db"
    },
    "manual":"false"
    },
    "dataSummaries":{
        "6":86927,
        "9":19227,
        "5":5095,
        "24":954
    },
    "datastream":{
        "0":{
            "5":0,
            "6":0,
            "36":0
        },
        "1":{
            "5":0,
            "6":20135,
            "36":0
        },
        "2":{
            "5":24,
            "6":86927,
            "36":0
        },
        "3":{
            "5":24,
            "6":86927,
            "36":0
        },
        "4":{
            "5":32,
            "6":15752,
            "36":0
        },
        "5":{
            "5":32,
            "6":15752,
            "36":0
        },
        "6":{
            "5":42,
            "6":35303,
            "36":0
        },
        "7":{
            "5":42,
            "6":35303,
            "36":0
        },
        "8":{
            "5":52,
            "6":17334,
            "36":0
        },
        "9":{
            "5":52,
            "6":17334,
            "36":0
        },
        "10":{
            "5":65,
            "6":23206,
            "36":0
        },
        "11":{
            "5":65,
            "6":23206,
            "36":0
    }
    },
    "locations":{
        "0":{
            "latitude":50.638437762,
            "longitude":3.125975041,
            "elevation":0
        },
        "5":{
            "latitude":50.63821090457489,
            "longitude":3.125491838207934,
            "elevation":0
        },
        "11":{
            "latitude":50.63806783149301,
            "longitude":3.125056386784151,
            "elevation":0
        }
    }
}

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/activities \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{ {
    "name":"My workout",
    "startdate":"2018-04-19T08:28:49+02:00",
    "duration":954,
    "user":"/v2/users/{{ldid}}" ... }'

Response

status 201 : Created
{
    "@context": "/v2/contexts/Activity",
    "@id": "/v2/activities/eu2a8ff4b670340f5144",
    "@type": "Activity",
    "id": "eu2a8ff4b670340f5144",
    "name": "My workout",
    "user": "/v2/users/ed3a20dfabaf09ae73f6",
    "sport": "/v2/sports/381",
    "userDevice": null,
    "startdate": "2018-04-19T08:28:49+02:00",
    "duration": 954,
    "latitude": null,
    "longitude": null,
    "elevation": null,
    "manual": false,
    "comment": null,
    "connector": "/v2/connectors/702",
    "userSession": null,
    "correctedElevation": false,
    "images": [],
    "thumbnail": "https://linkdata-ressources.geonaute.com/sports/381_h.jpg",
    "dataSummaries": {
        "5": 5095,
        "6": 86927,
        "9": 19227,
        "23": 148,
        "24": 954,
        "99": 88
    },
    "tags": [],
    "trackFlag": true,
    "datastreamFlag": true,
    "globalChallenge": null,
    "availableDatatypes": [
        6,
        9,
        5,
        24,
        23,
        99,
        36
    ],
    "createdAt": "2018-06-25T08:28:18+00:00",
    "updatedAt": "2018-06-25T08:28:18+00:00"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Some abstraction with referentials

Each sport has an ID ...91 = fitness ...121 = running ...Etc.
Each data has a data_type id. ...Ex : speed, distance, duration, speed max, speed min, speed average, steps, elevation ... ...24 = duration ...5 = distance ...Etc.

These abstractions allow to manipulate any sports with any data. (Tennis, running, swimming, golf, etc.)

User Records

All

These records concern the best activities on global value (datasummary)

Distance (5)
Average speed (9)
Duration (24)
Kcal (23)
ON points (99)
Ascent : Elevation gain (18)
Descent : Elevation loss (19)

Inside activity

These records are calculated inside the activity. You could do a slow 10 km but with the best 200m of your life. We grab it and store it here. All these records are with datatype duration (24) in seconds (aka the time to complete the distance).

distance.200m
distance.400m
distance.804m
distance.1000m
distance.1609m
distance.3218m
distance.5000m
distance.10000m
distance.21097m
distance.42195m
distance.80000m
distance.100000m

Retreive user's records

Get the collection of records.

Request

GET https://api.decathlon.net/sportstrackingdata/v2/user_records

Here we get all records for an user and specify the sport 121 (aka Running cf /v2/sports)

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/user_records?sport=121 \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \

Response

status 200 : Ok
{
    "@context": "/v2/contexts/UserRecord",
    "@id": "/v2/user_records",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/user_records/1558821",
            "@type": "UserRecord",
            "id": "1558821",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/5",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 7651,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558827",
            "@type": "UserRecord",
            "id": "1558827",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/99",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 353,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558826",
            "@type": "UserRecord",
            "id": "1558826",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 2561,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558825",
            "@type": "UserRecord",
            "id": "1558825",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/23",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 538,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558824",
            "@type": "UserRecord",
            "id": "1558824",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/19",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 39,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558823",
            "@type": "UserRecord",
            "id": "1558823",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/18",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 40,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558822",
            "@type": "UserRecord",
            "id": "1558822",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/9",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 10755,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558816",
            "@type": "UserRecord",
            "id": "1558816",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.804m",
            "value": 246,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558820",
            "@type": "UserRecord",
            "id": "1558820",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.5000m",
            "value": 1654,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558815",
            "@type": "UserRecord",
            "id": "1558815",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.400m",
            "value": 116,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558817",
            "@type": "UserRecord",
            "id": "1558817",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.1000m",
            "value": 312,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558818",
            "@type": "UserRecord",
            "id": "1558818",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.1609m",
            "value": 515,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558814",
            "@type": "UserRecord",
            "id": "1558814",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.200m",
            "value": 57,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558819",
            "@type": "UserRecord",
            "id": "1558819",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.3218m",
            "value": 1044,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558802",
            "@type": "UserRecord",
            "id": "1558802",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/5",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 934,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558808",
            "@type": "UserRecord",
            "id": "1558808",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/99",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 24,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558803",
            "@type": "UserRecord",
            "id": "1558803",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/9",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 5797,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558807",
            "@type": "UserRecord",
            "id": "1558807",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 580,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558806",
            "@type": "UserRecord",
            "id": "1558806",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/23",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 37,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558804",
            "@type": "UserRecord",
            "id": "1558804",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/18",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 9,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558805",
            "@type": "UserRecord",
            "id": "1558805",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/19",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 10,
            "createdAt": "2019-01-30T20:18:54+00:00",
            "updatedAt": "2019-01-30T20:18:54+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558799",
            "@type": "UserRecord",
            "id": "1558799",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "distance.200m",
            "value": 112,
            "createdAt": "2019-01-30T20:18:53+00:00",
            "updatedAt": "2019-01-30T20:18:53+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558800",
            "@type": "UserRecord",
            "id": "1558800",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "distance.400m",
            "value": 236,
            "createdAt": "2019-01-30T20:18:53+00:00",
            "updatedAt": "2019-01-30T20:18:53+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        },
        {
            "@id": "/v2/user_records/1558801",
            "@type": "UserRecord",
            "id": "1558801",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu2511d65eadf35f5083",
            "sport": "/v2/sports/121",
            "type": "distance.804m",
            "value": 491,
            "createdAt": "2019-01-30T20:18:53+00:00",
            "updatedAt": "2019-01-30T20:18:53+00:00",
            "date": "2019-01-30T12:00:00+00:00"
        }
    ],
    "hydra:view": {
        "@id": "/v2/user_records?sport=121&page=1",
        "@type": "hydra:PartialCollectionView"
    },
    "hydra:search": {
        "@type": "hydra:IriTemplate",
        "hydra:template": "/v2/user_records{?activity,activity[],sport,sport[],type,type[],order[id],order[type],order[value],order[createdAt],order[updatedAt]}",
        "hydra:variableRepresentation": "BasicRepresentation",
        "hydra:mapping": [
            {
                "@type": "IriTemplateMapping",
                "variable": "activity",
                "property": "activity",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "activity[]",
                "property": "activity",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "sport",
                "property": "sport",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "sport[]",
                "property": "sport",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "type",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "type[]",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[id]",
                "property": "id",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[type]",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[value]",
                "property": "value",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[createdAt]",
                "property": "createdAt",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[updatedAt]",
                "property": "updatedAt",
                "required": false
            }
        ]
    }
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Focus on record element

{
            "@id": "/v2/user_records/1558822",
            "@type": "UserRecord",
            "id": "1558822",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/9",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "all",
            "value": 10755,
            "createdAt": "2019-01-30T20:19:53+00:00",
            "updatedAt": "2019-01-30T20:19:53+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        }

We can distinguish, five major fields :

datatype : it is the type of record : max time, max elevation gain, max average speed (cf /v2/datatypes)
activity : it is the ressource id of the activity which owns this record
sport : the sport record : running, walking...
type : All represent a record on the entire activity, the others represent a part of the activity, for example "distance.5000m" it is your best 5K
value : it is the value of your record for example 15000 m/h for average speed in running

A record type all

datatype : 9 (average speed)
sport : 121 (running)
type : all
value : 10755 (10,755 km/h)
activity : eu21ec7ac76128fa6151

A record type distance.x

A record type distance.5000m

        {
            "@id": "/v2/user_records/1558820",
            "@type": "UserRecord",
            "id": "1558820",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/24",
            "activity": "/v2/activities/eu21ec7ac76128fa6151",
            "sport": "/v2/sports/121",
            "type": "distance.5000m",
            "value": 1654,
            "createdAt": "2019-01-30T20:19:52+00:00",
            "updatedAt": "2019-01-30T20:19:52+00:00",
            "date": "2018-11-18T12:00:00+00:00"
        }

datatype : 24 (duration seconds)
sport : 121 (running)
type : distance.5000m
value : 1654 (27min)
activity : eu21ec7ac76128fa6151

Calculation of records

The records are calculated automatically after the import of an activity. To delete a record, you have to modify or delete the activity attached to the record.

It is possible to activate public sharing of an activity. Everyone will be able to access to the activity by API without any user security.

When you share an activity, you create a public token that you can repudiate.

Firstly, you need the URI of the activity that you want to share, example :

"/v2/activities/eu2511d65eadf35f5083"

Request

GET https://api.decathlon.net/sportstrackingdata/v2/share_activities

Request Body

{
  "user": "/v2/users/eu23d736c047075def68",
  "activity": "/v2/activities/eu2511d65eadf35f5083"
}

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/share_activities \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
  "user": "/v2/users/eu23d736c047075def68",
  "activity": "/v2/activities/eu2511d65eadf35f5083"
}'

Response

status 201 : Created
{
    "@context": "/v2/contexts/ShareActivity",
    "@id": "/v2/share_activities/eu244e2e987f749dbde5",
    "@type": "ShareActivity",
    "id": "eu244e2e987f749dbde5",
    "user": "/v2/users/eu23d736c047075def68",
    "activity": {
        "@id": "/v2/activities/eu2511d65eadf35f5083",
        "@type": "Activity",
        "id": "eu2511d65eadf35f5083",
        "name": "Test V2 - Android - 30 janvier 2019",
        "user": "/v2/users/eu23d736c047075def68",
        "sport": "/v2/sports/121",
        "userDevice": null,
        "startdate": "2019-01-30T12:00:00+00:00",
        "duration": 580,
        "latitude": 50.6445,
        "longitude": 3.14039,
        "elevation": 28,
        "manual": true,
        "comment": null,
        "connector": null,
        "userSession": null,
        "images": [],
        "thumbnail": "https://linkdata-ressources-eu2.geonaute.com/preprod/eu23d736c047075def68/maps/eu2511d65eadf35f5083.png",
        "dataSummaries": {
            "5": 934,
            "7": 9000,
            "9": 5797,
            "15": 37,
            "16": 27,
            "18": 9,
            "19": 10,
            "23": 37,
            "24": 580,
            "97": 24,
            "99": 24
        },
        "globalChallenge": null,
        "availableDatatypes": [
            5,
            7,
            9,
            15,
            16,
            18,
            19,
            23,
            24,
            97,
            99,
            14,
            6
        ],
        "createdAt": "2019-01-30T20:18:51+00:00",
        "updatedAt": "2019-01-30T20:18:54+00:00",
        "datastream": {
            "0": {
                "5": 0,
                "6": 4680,
                "14": 28.40039
            },
            "4": {
                "5": 5,
                "6": 4400,
                "14": 28.299805
            },
            "5": {
                "5": 6,
                "6": 4320,
                "14": 28.299805
            },
            "9": {
                "5": 11,
                "6": 5400,
                "14": 28.299805
            },
            "10": {
                "5": 13,
                "6": 5400,
                "14": 28.299805
            },
            ...
        },
        "locations": {
            "0": {
                "latitude": 50.6445,
                "longitude": 3.14039,
                "elevation": 28.40039
            },
            "4": {
                "latitude": 50.64447,
                "longitude": 3.14033,
                "elevation": 28.299805
            },
            "5": {
                "latitude": 50.64446,
                "longitude": 3.14032,
                "elevation": 28.299805
            },
            ...
        },
        "tags": null
    }
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Thank to the new share URI : "/v2/share_activities/eu244e2e987f749dbde5" you will be able to get this activity.

GET the activity

Curl

curl -X GET \
  https://api.decathlon.net/sportstrackingdata/v2/share_activities/eu244e2e987f749dbde5 \
  -H 'Accept: application/ld+json, application/json, text/html'
  -H 'x-api-key: {your api key}' \

Once the share public token generated, you can GET the activity without any user security.

GET "/v2/share_activities/eu244e2e987f749dbde5"

Photos and Thumbnails

By default, for each sport activity the API generates a thumbnail (a map or a picture of the sport practiced). You could change this thumbnail url and add many url photos to your activity. To facilitate the use of url, we provide an API to store pictures online.

Content	Level	Limitation
Thumbnail	Recommandation	less than 300Ko
Photo	Mandatory	less than 3Mo

Upload a photo

Request

POST https://api.decathlon.net/sportstrackingdata/v2/upload

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/upload \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -F 'file=@/path/myphoto.jpg'

Response

status 200 : Ok
{
"url":"https:\/\/example.com/2caf4b77b497b64bef1c3ba2b1d0744f25db3ce3"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Add photo to an activity

Request

PUT https://api.decathlon.net/sportstrackingdata/v2/activities/TOKEN

Curl

curl -X PUT \
    https://api.decathlon.net/sportstrackingdata/v2/activities/TOKEN \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
"images":["https://example.com/2caf4b77b497b64bef1c3ba2b1d0744f25db3ce3"]
}'

Change the thumbnail

Curl

curl -X PUT \
    https://api.decathlon.net/sportstrackingdata/v2/activities/TOKEN \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
"thumbnail":"https://example.com/2caf4b77b497b64bef1c3ba2b1d0744f25db3ce3"
}'

Before changing the thumbnail, it could be useful to save the actual thumbnail as an image to not lose the url generated by the API.

Request

PUT https://api.decathlon.net/sportstrackingdata/v2/activities/TOKEN

User measures

User measures allows you to do quantified self for your body on many datatypes (weight, Body fat, height, Heart rate min, max, ...). Each measure is dated, when you get a collection you can show the evolution of the datatype selected.

Reminder about Datatypes

For these examples we will use the datatype 181: Weight in gramms :

GET https://api.decathlon.net/sportstrackingdata/v2/datatypes/181

{
    "@context": "/v2/contexts/Datatype",
    "@id": "/v2/datatypes/181",
    "@type": "Datatype",
    "id": 181,
    "unit": "g",
    "translatedNames": {
        "en": "Weight"
    },
    "translatedDescriptions": {
        "en": null
    },
    "recordWay": 0,
    "cumulable": false,
    "active": true,
    "createdAt": "2018-03-14T21:36:31+00:00",
    "updatedAt": "2018-03-23T10:23:55+00:00"
}

Create a new user measure

Request

POST https://api.decathlon.net/sportstrackingdata/v2/user_measures

Request Body

{
  "user": "/v2/users/eu23d736c047075def68",
  "datatype": "/v2/datatypes/181",
  "value": 70000,
  "date": "2018-04-18T19:36:41.081Z"
}

You will need to indicated some URI ressources to create a new user measure :

datatype refers to the unit of the measure
user refers to the URI of your user

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/user_measures \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
  "user": "/v2/users/eu23d736c047075def68",
  "datatype": "/v2/datatypes/181",
  "value": 70000,
  "date": "2018-04-18T19:36:41.081Z"
}'

Response

status 201 : Created
{
    "@context": "/v2/contexts/UserMeasure",
    "@id": "/v2/user_measures/738526",
    "@type": "UserMeasure",
    "id": "738526",
    "user": "/v2/users/eu23d736c047075def68",
    "datatype": "/v2/datatypes/181",
    "value": 70000,
    "date": "2018-04-18T19:36:41+00:00",
    "createdAt": "2019-01-30T21:12:15+00:00",
    "updatedAt": "2019-01-30T21:12:15+00:00"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Get user measures

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/user_measures?datatype=181 \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}'

Response

status 200 : Ok
{
    "@context": "/v2/contexts/UserMeasure",
    "@id": "/v2/user_measures",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/user_measures/738525",
            "@type": "UserMeasure",
            "id": "738525",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/181",
            "value": 90000,
            "date": "2019-01-30T20:16:36+00:00",
            "createdAt": "2019-01-30T20:16:36+00:00",
            "updatedAt": "2019-01-30T20:16:36+00:00"
        },
        {
            "@id": "/v2/user_measures/738526",
            "@type": "UserMeasure",
            "id": "738526",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/181",
            "value": 70000,
            "date": "2018-04-18T19:36:41+00:00",
            "createdAt": "2019-01-30T21:12:15+00:00",
            "updatedAt": "2019-01-30T21:12:15+00:00"
        },
        {
            "@id": "/v2/user_measures/738528",
            "@type": "UserMeasure",
            "id": "738528",
            "user": "/v2/users/eu23d736c047075def68",
            "datatype": "/v2/datatypes/181",
            "value": 69042,
            "date": "2019-01-18T19:36:41+00:00",
            "createdAt": "2019-01-30T21:14:18+00:00",
            "updatedAt": "2019-01-30T21:14:18+00:00"
        }
    ],
    "hydra:view": {
        "@id": "/v2/user_measures?datatype=181&page=1",
        "@type": "hydra:PartialCollectionView"
    },
    "hydra:search": {
        "@type": "hydra:IriTemplate",
        "hydra:template": "/v2/user_measures{?user,user[],date,date[],datatype,datatype[],order[id],order[value],order[date],order[dateTimezone],order[createdAt],order[updatedAt],date[before],date[strictly_before],date[after],date[strictly_after]}",
        "hydra:variableRepresentation": "BasicRepresentation",
        "hydra:mapping": [
            {
                "@type": "IriTemplateMapping",
                "variable": "user",
                "property": "user",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "user[]",
                "property": "user",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date[]",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "datatype",
                "property": "datatype",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "datatype[]",
                "property": "datatype",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[id]",
                "property": "id",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[value]",
                "property": "value",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[date]",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[dateTimezone]",
                "property": "dateTimezone",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[createdAt]",
                "property": "createdAt",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[updatedAt]",
                "property": "updatedAt",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date[before]",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date[strictly_before]",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date[after]",
                "property": "date",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "date[strictly_after]",
                "property": "date",
                "required": false
            }
        ]
    }
}
status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

User statistics

The user_sumups can give you consolidated statistics on period (years and months). The user_sumups element :

an user_id
a sport (121 running, ...)
a datatype (5 distance meter, ...)
a period (2019, 201901, ...)

Parameters

The API accepts many parameters to reach quickly the data you want.

period
period[]
user,user[]
type,type[]
order[id]
order[type]
order[period]
order[value]
order[createdAt]
order[updatedAt]
period[between]
period[gt]
period[gte]
period[lt]
period[lte]

Retreive user's sumups

In this example we will look for statistics on 2018 for the running sport (121)

Request

GET https://api.decathlon.net/sportstrackingdata/v2/user_sumups

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/user_sumups?period=2018&sport=121 \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \

Response

status 200 : Ok
{
    "@context": "/v2/contexts/UserSumup",
    "@id": "/v2/user_sumups",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/user_sumups/5774260",
            "@type": "UserSumup",
            "id": "5774260",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/5",
            "period": "2018",
            "value": 7651,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774261",
            "@type": "UserSumup",
            "id": "5774261",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/18",
            "period": "2018",
            "value": 40,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774262",
            "@type": "UserSumup",
            "id": "5774262",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/19",
            "period": "2018",
            "value": 39,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774263",
            "@type": "UserSumup",
            "id": "5774263",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/23",
            "period": "2018",
            "value": 538,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774264",
            "@type": "UserSumup",
            "id": "5774264",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/24",
            "period": "2018",
            "value": 2561,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774265",
            "@type": "UserSumup",
            "id": "5774265",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/97",
            "period": "2018",
            "value": 353,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774266",
            "@type": "UserSumup",
            "id": "5774266",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/99",
            "period": "2018",
            "value": 353,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        },
        {
            "@id": "/v2/user_sumups/5774267",
            "@type": "UserSumup",
            "id": "5774267",
            "type": "YearlySumup",
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121",
            "datatype": "/v2/datatypes/98",
            "period": "2018",
            "value": 1,
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        }
    ],
    "hydra:view": {
        "@id": "/v2/user_sumups?period=2018&sport=121&page=1",
        "@type": "hydra:PartialCollectionView"
    },
    "hydra:search": {
        "@type": "hydra:IriTemplate",
        "hydra:template": "/v2/user_sumups{?period,period[],user,user[],type,type[],order[id],order[type],order[period],order[value],order[createdAt],order[updatedAt],period[between],period[gt],period[gte],period[lt],period[lte]}",
        "hydra:variableRepresentation": "BasicRepresentation",
        "hydra:mapping": [
            {
                "@type": "IriTemplateMapping",
                "variable": "period",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "user",
                "property": "user",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "user[]",
                "property": "user",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "type",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "type[]",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[id]",
                "property": "id",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[type]",
                "property": "type",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[period]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[value]",
                "property": "value",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[createdAt]",
                "property": "createdAt",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "order[updatedAt]",
                "property": "updatedAt",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[between]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[gt]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[gte]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[lt]",
                "property": "period",
                "required": false
            },
            {
                "@type": "IriTemplateMapping",
                "variable": "period[lte]",
                "property": "period",
                "required": false
            }
        ]
    }
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Explaining a sumup element

{
            "@id": "/v2/user_sumups/5774260",
            "@type": "UserSumup",
            "id": "5774260",
            "type": "YearlySumup", //type year
            "user": "/v2/users/eu23d736c047075def68",
            "sport": "/v2/sports/121", //sport running 121
            "datatype": "/v2/datatypes/5", // Distance in meter
            "period": "2018",
            "value": 7651, // value realised so 7,6Km of running in 2018
            "createdAt": "2019-01-30T20:19:54+00:00",
            "updatedAt": "2019-01-30T20:19:54+00:00"
        }

User Agreement

An easy solution to store the user agreement to use your service.

WARNING : once you have User Agreements on an account, if they are all rejected, the user account is deleted. If there is no anymore agreement accepted, we don't have the right to store the user data.

Create an user agreement

You store the acceptance of your user on your service and the filename of your legal contract.

Each user agreement has a state ( accepted | pending | rejected ).

Request

POST https://api.decathlon.net/sportstrackingdata/v2/user_agreements

Curl

curl -X POST \
    https://api.decathlon.net/sportstrackingdata/v2/user_agreements \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
  "user": "/v2/users/#USERLDID#",
  "serviceKey": "DecathlonCoach",
  "state": "accepted",
  "filename": "legal-document-CGS-v1.1-20180808"
    }'

Response

status 201 : Created
{
    "@context": "/v2/contexts/UserAgreement",
    "@id": "/v2/user_agreements/1",
    "@type": "UserAgreement",
    "id": 1,
    "user": "/v2/users/820d0a384a7013997f69",
    "serviceKey": "DecathlonCoach",
    "state": "accepted",
    "dateAccept": "2018-08-10T13:28:10+00:00",
    "dateRepudiation": null,
    "filename": "legal-document-CGS-v1.1-20180808",
    "createdAt": "2018-08-10T13:28:10+00:00",
    "updatedAt": "2018-08-10T13:28:10+00:00"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Get the collection of User Agreement or a single ressource

You can list all the user agreements and access to specific one.

Request

GET https://api.decathlon.net/sportstrackingdata/v2/user_agreements

GET https://api.decathlon.net/sportstrackingdata/v2/user_agreements/#RESSOURCEID#

Curl

curl -X GET \
    https://api.decathlon.net/sportstrackingdata/v2/user_agreements \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}'

Response

status 200 : Ok
{
    "@context": "/v2/contexts/UserAgreement",
    "@id": "/v2/user_agreements",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/user_agreements/1",
            "@type": "UserAgreement",
            "id": 1,
            "user": "/v2/users/820d0a384a7013997f69",
            "serviceKey": "DecathlonCoach",
            "state": "accepted",
            "dateAccept": "2018-08-10T13:28:10+00:00",
            "dateRepudiation": null,
            "filename": "legal-document-CGS-v1.1-20180808",
            "createdAt": "2018-08-10T13:28:10+00:00",
            "updatedAt": "2018-08-10T13:28:10+00:00"
        }
    ]
}
status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Modify an user agreement

You can modify the state of an user agreement. For example if an user wants to revoke its acceptance to the service.

Request

PUT https://api.decathlon.net/sportstrackingdata/v2/user_agreements/#RESSOURCEID#

Curl

curl -X PUT \
    https://api.decathlon.net/sportstrackingdata/v2/user_agreements/#RESSOURCEID# \
  -H 'Authorization: Bearer {your bearer}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {your api key}' \
  -d '{
  "state": "rejected"
    }'

Response

status 200 : OK
{
    "@context": "/v2/contexts/UserAgreement",
    "@id": "/v2/user_agreements/1",
    "@type": "UserAgreement",
    "id": 1,
    "user": "/v2/users/820d0a384a7013997f69",
    "serviceKey": "DecathlonCoach",
    "state": "rejected",
    "dateAccept": "2018-08-10T13:28:10+00:00",
    "dateRepudiation": null,
    "filename": "legal-document-CGS-v1.1-20180808",
    "createdAt": "2018-08-10T13:28:10+00:00",
    "updatedAt": "2018-08-10T13:28:10+00:00"
}

status 4xx : Client errors, check response for details.

status 5xx : Server errors, check response for details.

Glossary

Activity : represent a sport activity, 3 data are mandatory : a sport, a date, a duration
Connected device : the device which capture a sport activity (like Decathlon Coach App iOs, or On Move 500
Connector : the app which uploads an activity
Datatype : our abstraction of the different type of unit : distance (m) , duration (s), weight (g) , ...
Manual Activity : an activity generated by a form or an import for a file GPX or TCX
Measure : A body measure stored for an user, the measure is defined by a Datatype, a value and a date
Sport id : our abstraction of the list of the sports (ex : 121 for the running, 113 for walking...)
Sumup : any data consolidated to a datatype, a sport and a period (month or year) # Roadmap

V1 retro-compatibility

The v1 is supported until 2020. The v1 doesn't receive the new features.

V2 new features

Kcal refactoring 2019-Q1
Callback / webhook 2019-Q1
Connected Cloackroom 2019-Q2
Change the Oauth server 2019-Q3

Support

contacts

Mailing list API users : sports-tracking-data-api-news@googlegroups.com
Support contact : infra@decathloncoach.com

Pre-requisites to support

the request
result
transaction identifiers

And/Or :

a timestamp
an IP # Discussion

If you have any questions, feedbacks, feel free to share it on our Google groups : https://groups.google.com/forum/#!forum/sports-tracking-data-api-news

Language prefered : English.

Errors

This error section is stored in a separate file in includes/_errors.md. Slate allows you to optionally separate out your docs into many files...just save them to the includes folder and add them to the top of your index.md's frontmatter. Files are included in the order listed.

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Sports Tracking Data API

Sport activity tracking

API Description

Main benefits

Global vision

API conventions

API Registration

Swagger

Authentification

Login flow Authorization Code

Get JWT bearer

JWT payload structure

Main operations

The first call

Referentials

Main referentials

Example with Sport referential

Connected products referentials

Other referentials

Create a device

Request

Serial number of the device

Memo : why the device management is important

Retreive activities

Request

Filters

Add an activity

Request

Request Body

Some abstraction with referentials

User Records

All

Inside activity

Retreive user's records

Request

Focus on record element

A record type all

A record type distance.x

Calculation of records

Share an activity

Create the public share token

Request

Request Body

GET the activity

Photos and Thumbnails

Upload a photo

Request

Add photo to an activity

Request

Change the thumbnail

Request

User measures

Reminder about Datatypes

Create a new user measure

Request

Get user measures

User statistics

Parameters

Retreive user's sumups

Request

Explaining a sumup element

User Agreement

Create an user agreement

Request

Get the collection of User Agreement or a single ressource

Request

Modify an user agreement

Request

Glossary

V1 retro-compatibility

V2 new features

Support

contacts

Pre-requisites to support

Errors