get_segment_leaderboard: get_segment_leaderboard

In longwei66/mountainbikeR: A package for mountainbikers to access and visualise ride data through strava API

Description

Returns the specified segment leaderboard.

Usage

get_segment_leaderboard(
  mbr_object = NULL,
  segment_id = NULL,
  gender = NULL,
  age_group = NULL,
  weight_class = NULL,
  following = NULL,
  club_id = NULL,
  date_range = NULL,
  context_entries = NULL,
  page = NULL,
  per_page = NULL
)

Arguments

segment_id	int The identifier of the segment leaderboard.
gender	string, Filter by gender. May take one of the following values: M, F
age_group	string summit Feature. Filter by age group. May take one of the following values: 0_19, 20_24, 25_34, 35_44, 45_54, 55_64, 65_69, 70_74, 75_plus
weight_class	string, filter by weight class. May take one of the following values: 0_124, 125_149, 150_164, 165_179, 180_199, 200_224, 225_249, 250_plus, 0_54, 55_64, 65_74, 75_84, 85_94, 95_104, 105_114, 115_plus
following	Boolean Filter by friends of the authenticated athlete.
club_id	Long,Filter by club id
date_range	string, Filter by date range, will be in the athlete's timezone May take one of the following values: this_year, this_month, this_week, today
context_entries	Integer, ??? not documented
page	Integer, Page number
per_page	integer, Number of items per page. Defaults to 30.

Value

my_segment_leaderboard as list with leaderboard

See Also

https://developers.strava.com/docs/reference/#api-Segments-getLeaderboardBySegmentId

Examples

## Not run: 
# my_mbr is a mountainbikeR object

my_mbr$get_segment_leaderboard(
)

## End(Not run)

longwei66/mountainbikeR documentation built on April 16, 2020, 6:23 p.m.