Strava v0.0.1 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 :: %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)

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)

Specs

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

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)

Specs

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

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}, %{per_page: 10, page: 1})

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

retrieve(id)

Specs

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

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 \\ %{})

Specs

stream_efforts(number, map) :: Enumerable.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