Retrieve an activity

GET/clubs/{connection_id}/activity/{id}

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Activity

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this activity (not provided by ClubActivity)
created_atstring (date-time)NoThe date that this activity was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this activity was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
group_idstringNoThe group this activity was listed under (reference to HrisGroup)
namestringNoThe name of the activity
descriptionstringNoThe description of the activity (DetailedActivity only)
typeenumNoThe activity type Values: RUNNING, CYCLING, SWIMMING, TRIATHLON, WALKING, HIKING, OTHER
athlete_idstringNoThe id of the athlete who performed the activity (DetailedActivity only)
athlete_namestringNoThe full name of the athlete
distancenumberNoThe activity's distance, in meters
moving_timenumberNoThe activity's moving time, in seconds
elapsed_timenumberNoThe activity's elapsed time, in seconds
total_elevation_gainnumberNoThe activity's total elevation gain, in meters
elevation_highnumberNoThe activity's highest elevation, in meters (DetailedActivity only)
elevation_lownumberNoThe activity's lowest elevation, in meters (DetailedActivity only)
start_atstring (date-time)NoWhen the activity started (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
timezonestringNoThe timezone of the activity
achievement_countnumberNoThe number of achievements gained during this activity
kudos_countnumberNoThe number of kudos given for this activity
comment_countnumberNoThe number of comments for this activity
athlete_countnumberNoThe number of athletes that took part in this activity
photo_countnumberNoThe number of Instagram photos for this activity
average_speednumberNoThe activity's average speed, in meters per second
max_speednumberNoThe activity's max speed, in meters per second
average_cadencenumberNoThe activity's average cadence
average_heartratenumberNoThe activity's average heart rate, in beats per minute
max_heartratenumberNoThe activity's max heart rate, in beats per minute
average_wattsnumberNoThe activity's average power output, in watts
max_wattsnumberNoThe activity's max power output, in watts
weighted_average_wattsnumberNoThe activity's weighted average power output, in watts
kilojoulesnumberNoThe total work done, in kilojoules
caloriesnumberNoThe number of kilocalories consumed during this activity
has_heartratebooleanNoWhether the activity has heart rate data
is_trainerbooleanNoWhether this activity was recorded on a training machine
is_commutebooleanNoWhether this activity is a commute
is_manualbooleanNoWhether this activity was created manually
is_privatebooleanNoWhether this activity is private
map_polylinestringNoThe detailed polyline of the activity's map
map_summary_polylinestringNoThe summary polyline of the activity's map
workout_typenumberNoThe activity's workout type
suffer_scorenumberNoThe activity's relative effort score
pr_countnumberNoThe number of personal records set during this activity

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/clubs/5de520f96e439b002043d8dc/activity/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?