Get the Eddington numbers

GET

/api/v1/metrics/eddington

const url = 'http://localhost:8080/api/v1/metrics/eddington';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/metrics/eddington \
  --header 'Authorization: Bearer <token>'

Returns every Eddington number configured under Settings → Metrics

Authorizations

apiKey

Responses

200

The Eddington numbers.

application/json

Array<object>

object

label

required

string

sportTypes

required

The sport types that count towards this Eddington number.

Array<string>

unit

required

The unit of number and longestDistanceInADay.

string

Allowed values: km mi

number

required

integer

daysNeededForNextNumber

required

How many more days with at least number + 1 units are needed to reach it.

integer

longestDistanceInADay

required

The longest distance covered in a single day.

integer

Example

[
  {
    "label": "Ride",
    "sportTypes": [
      "Ride",
      "MountainBikeRide",
      "GravelRide",
      "VirtualRide"
    ],
    "unit": "km",
    "number": 52,
    "daysNeededForNextNumber": 7,
    "longestDistanceInADay": 160
  }
]

401

The Authorization header was missing, malformed, or did not match the configured key.

application/json

Every error uses this shape.

object

error

required

A stable, machine readable code.

string

Allowed values: invalid_token missing_file unsupported_media_type unsupported_file_type file_too_large import_mode_not_files gpx_not_available not_found method_not_allowed bad_request forbidden internal_error

message

required

string

Examples

invalidToken

{
  "error": "invalid_token",
  "message": "A valid API token is required. Send it in the Authorization header as a Bearer token."
}

Headers

WWW-Authenticate

string