Strava

v1.0.0

Strava v1.0.0 Strava.SegmentEfforts View Source

API calls for all endpoints tagged SegmentEfforts.

Link to this section Summary

Functions

get_efforts_by_segment_id(client, id, opts \\ [])

List Segment Efforts

get_segment_effort_by_id(client, id, opts \\ [])

Get Segment Effort Returns a segment effort from an activity that is owned by the authenticated athlete

Link to this section Functions

Link to this function

get_efforts_by_segment_id(client, id, opts \\ []) View Source 
get_efforts_by_segment_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, [Strava.DetailedSegmentEffort.t()]} | {:error, Tesla.Env.t()}

List Segment Efforts

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

Parameters

  • client (Strava.Client) - Client to make authenticated requests
  • id (integer()) - The identifier of the segment.

  • opts (KeywordList) - [optional] Optional parameters

    • :page (integer()) - Page number.
    • :per_page (integer()): Number of items per page. Defaults to 30.
    • :start_date_local (date/time encoded as an ISO9601 string) - Restrict efforts to after the local start date.
    • :end_date_local (date/time encoded as an ISO9601 string) - Restrict efforts to before the local end date.

Note for start and end local date filtering both values must be provided.

Returns

{:ok, [%DetailedSegmentEffort{}, ...]} on success {:error, info} on failure

Link to this function

get_segment_effort_by_id(client, id, opts \\ []) View Source 
get_segment_effort_by_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Strava.DetailedSegmentEffort.t()} | {:error, Tesla.Env.t()}

Get Segment Effort Returns a segment effort from an activity that is owned by the authenticated athlete.

Parameters

  • client (Strava.Client): Client to make authenticated requests
  • id (integer()): The identifier of the segment effort.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Strava.DetailedSegmentEffort{}} on success {:error, info} on failure