clubs
activity

Retrieve an activity

get/clubs/{connection_id}/activity/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/clubs/{connection_id}/activity/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Activity

Query parameters

fieldsstring[]

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

Response

Successful

idstring

Unique identifier for this activity (not provided by ClubActivity)

created_atstring date-time

The date that this activity was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this activity was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

group_idstring

The group this activity was listed under (reference to HrisGroup)

namestring

The name of the activity

descriptionstring

The description of the activity (DetailedActivity only)

type'RUNNING' | 'CYCLING' | 'SWIMMING' | 'TRIATHLON' | 'WALKING' | 'HIKING' | 'OTHER'

The activity type

athlete_idstring

The id of the athlete who performed the activity (DetailedActivity only)

athlete_namestring

The full name of the athlete

distancenumber

The activity's distance, in meters

moving_timenumber

The activity's moving time, in seconds

elapsed_timenumber

The activity's elapsed time, in seconds

total_elevation_gainnumber

The activity's total elevation gain, in meters

elevation_highnumber

The activity's highest elevation, in meters (DetailedActivity only)

elevation_lownumber

The activity's lowest elevation, in meters (DetailedActivity only)

start_atstring date-time

When the activity started (UTC) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

timezonestring

The timezone of the activity

achievement_countnumber

The number of achievements gained during this activity

kudos_countnumber

The number of kudos given for this activity

comment_countnumber

The number of comments for this activity

athlete_countnumber

The number of athletes that took part in this activity

photo_countnumber

The number of Instagram photos for this activity

average_speednumber

The activity's average speed, in meters per second

max_speednumber

The activity's max speed, in meters per second

average_cadencenumber

The activity's average cadence

average_heartratenumber

The activity's average heart rate, in beats per minute

max_heartratenumber

The activity's max heart rate, in beats per minute

average_wattsnumber

The activity's average power output, in watts

max_wattsnumber

The activity's max power output, in watts

weighted_average_wattsnumber

The activity's weighted average power output, in watts

kilojoulesnumber

The total work done, in kilojoules

caloriesnumber

The number of kilocalories consumed during this activity

has_heartrateboolean

Whether the activity has heart rate data

is_trainerboolean

Whether this activity was recorded on a training machine

is_commuteboolean

Whether this activity is a commute

is_manualboolean

Whether this activity was created manually

is_privateboolean

Whether this activity is private

map_polylinestring

The detailed polyline of the activity's map

map_summary_polylinestring

The summary polyline of the activity's map

workout_typenumber

The activity's workout type

suffer_scorenumber

The activity's relative effort score

pr_countnumber

The number of personal records set during this activity

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.