Strava v0.2.0 Strava.Segment

Segments are specific sections of road. Athletes’ times are compared on these segments and leaderboards are created. https://strava.github.io/api/v3/segments/

Summary

Functions

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range for a given page

Retrieve details about a specific segment

Create a stream of segment efforts, for a given segment, filtered by athlete and/or a date range

Types

t()
t :: %Strava.Segment{activity_type: String.t, athlete_count: number, average_grade: number, city: String.t, climb_category: number, country: String.t, created_at: String.t, distance: number, effort_count: number, elevation_high: number, elevation_low: number, end_latlng: [number], hazardous: boolean, id: number, maximum_grade: number, name: String.t, private: boolean, resource_state: number, star_count: number, starred: boolean, start_latlng: [number], state: String.t, total_elevation_gain: number, updated_at: String.t}

Functions

list_efforts(id)
list_efforts(integer) :: [Strava.Segment.t]

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range.

Example

Strava.Segment.list_efforts(229781)

More info at: https://strava.github.io/api/v3/segments/#efforts

list_efforts(id, filters)
list_efforts(integer, map) :: [Strava.Segment.t]

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range.

Example

Strava.Segment.list_efforts(229781, %{athlete_id: 5287})

More info at: https://strava.github.io/api/v3/segments/#efforts

list_efforts(id, filters, pagination)
list_efforts(integer, map, Strava.Pagination.t) :: [Strava.Segment.t]

Retrieve an array of segment efforts, for a given segment, filtered by athlete and/or a date range for a given page.

Example

Strava.Segment.list_efforts(229781, %{athlete_id: 5287}, %Strava.Pagination{per_page: 10, page: 1})

More info at: https://strava.github.io/api/v3/segments/#efforts

retrieve(id)
retrieve(integer) :: Strava.Segment.t

Retrieve details about a specific segment.

Example

Strava.Segment.retrieve(229781)

More info at: https://strava.github.io/api/v3/segments/#retrieve

stream_efforts(id, filters \\ %{})
stream_efforts(integer, map) :: Enum.t

Create a stream of segment efforts, for a given segment, filtered by athlete and/or a date range.

Example

Strava.Segment.stream_efforts(229781)

More info at: https://strava.github.io/api/v3/segments/#efforts