SegmentEffortsApi
All URIs are relative to https://www.strava.com/api/v3
Method | HTTP request | Description |
---|---|---|
geteffortsbysegmentid | GET /segment_efforts | List Segment Efforts |
getsegmenteffortbyid | GET /segment_efforts/{id} | Get Segment Effort |
geteffortsbysegmentid
geteffortsbysegmentid(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
Name | Type | Description | Notes |
---|---|---|---|
_api | SegmentEffortsApi | API context | |
segment_id | Int64 | The identifier of the segment. |
Optional Parameters
Name | Type | Description | Notes |
---|---|---|---|
startdatelocal | ZonedDateTime | ISO 8601 formatted date time. | [default to nothing] |
enddatelocal | ZonedDateTime | ISO 8601 formatted date time. | [default to nothing] |
per_page | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
Return type
Authorization
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
getsegmenteffortbyid(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
Name | Type | Description | Notes |
---|---|---|---|
_api | SegmentEffortsApi | API context | |
id | Int64 | The identifier of the segment effort. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]