Records#

GET /api/records#

Get all records for authenticated user.

Following types of records are available:

  • average speed (record_type: AS)

  • farthest distance (record_type: FD)

  • highest ascent (record_type: HA)

  • longest duration (record_type: LD)

  • maximum speed (record_type: MS)

Scope: workouts:read

Example request:

GET /api/records HTTP/1.1
Content-Type: application/json

Example responses:

  • returning records

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "records": [
      {
        "id": 9,
        "record_type": "AS",
        "sport_id": 1,
        "user": "admin",
        "value": 18,
        "workout_date": "Sun, 07 Jul 2019 08:00:00 GMT",
        "workout_id": "hvYBqYBRa7wwXpaStWR4V2"
      },
      {
        "id": 10,
        "record_type": "FD",
        "sport_id": 1,
        "user": "admin",
        "value": 18,
        "workout_date": "Sun, 07 Jul 2019 08:00:00 GMT",
        "workout_id": "hvYBqYBRa7wwXpaStWR4V2"
      },
      {
        "id": 13,
        "record_type": "HA",
        "sport_id": 1,
        "user": "Sam",
        "value": 43.97,
        "workout_date": "Sun, 07 Jul 2019 08:00:00 GMT",
        "workout_id": "hvYBqYBRa7wwXpaStWR4V2"
      },
      {
        "id": 11,
        "record_type": "LD",
        "sport_id": 1,
        "user": "admin",
        "value": "1:01:00",
        "workout_date": "Sun, 07 Jul 2019 08:00:00 GMT",
        "workout_id": "hvYBqYBRa7wwXpaStWR4V2"
      },
      {
        "id": 12,
        "record_type": "MS",
        "sport_id": 1,
        "user": "admin",
        "value": 18,
        "workout_date": "Sun, 07 Jul 2019 08:00:00 GMT",
        "workout_id": "hvYBqYBRa7wwXpaStWR4V2"
      }
    ]
  },
  "status": "success"
}

  • no records

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "records": []
  },
  "status": "success"
}
Request Headers:
Status Codes:

  • 200 OK – success

  • 401 Unauthorized –

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again