SegmentEffortsApi

All URIs are relative to https://www.strava.com/api/v3

MethodHTTP requestDescription
geteffortsbysegmentidGET /segment_effortsList Segment Efforts
getsegmenteffortbyidGET /segment_efforts/{id}Get Segment Effort

geteffortsbysegmentid

get_efforts_by_segment_id(api::SegmentEffortsApi, `segmentid::Int64;startdatelocal=nothing,enddatelocal=nothing,perpage=nothing, _mediaType=nothing) ->Vector{DetailedSegmentEffort},OpenAPI.Clients.ApiResponse<br/>geteffortsbysegmentid`(api::SegmentEffortsApi, responsestream::Channel, `segmentid::Int64;startdatelocal=nothing,enddatelocal=nothing,per_page=nothing, _mediaType=nothing) ->Channel{Vector{DetailedSegmentEffort}},OpenAPI.Clients.ApiResponse`

List Segment Efforts

Returns a set of the authenticated athlete's segment efforts for a given segment. Requires subscription.

Required Parameters

NameTypeDescriptionNotes
_apiSegmentEffortsApiAPI context
segment_idInt64The identifier of the segment.

Optional Parameters

NameTypeDescriptionNotes
start_date_localZonedDateTimeISO 8601 formatted date time.[default to nothing]
end_date_localZonedDateTimeISO 8601 formatted date time.[default to nothing]
per_pageInt64Number of items per page. Defaults to 30.[default to 30]

Return type

Vector{DetailedSegmentEffort}

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getsegmenteffortbyid

get_segment_effort_by_id(api::SegmentEffortsApi, id::Int64; _mediaType=nothing) -> DetailedSegmentEffort, OpenAPI.Clients.ApiResponse <br/> `getsegmenteffortbyid`(api::SegmentEffortsApi, response_stream::Channel, id::Int64; _mediaType=nothing) -> Channel{ DetailedSegmentEffort }, OpenAPI.Clients.ApiResponse

Get Segment Effort

Returns a segment effort from an activity that is owned by the authenticated athlete. Requires subscription.

Required Parameters

NameTypeDescriptionNotes
_apiSegmentEffortsApiAPI context
idInt64The identifier of the segment effort.

Return type

DetailedSegmentEffort

Authorization

strava_oauth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]