ActivitiesApi
All URIs are relative to https://www.strava.com/api/v3
| Method | HTTP request | Description |
|---|---|---|
| create_activity | POST /activities | Create an Activity |
| getactivityby_id | GET /activities/{id} | Get Activity |
| getcommentsbyactivityid | GET /activities/{id}/comments | List Activity Comments |
| getkudoersbyactivityid | GET /activities/{id}/kudos | List Activity Kudoers |
| getlapsbyactivityid | GET /activities/{id}/laps | List Activity Laps |
| getloggedinathleteactivities | GET /athlete/activities | List Athlete Activities |
| getzonesbyactivityid | GET /activities/{id}/zones | Get Activity Zones |
| updateactivityby_id | PUT /activities/{id} | Update Activity |
create_activity
createactivity(api::ActivitiesApi, name::String, sporttype::String, startdatelocal::ZonedDateTime, elapsedtime::Int64; type=nothing, description=nothing, distance=nothing, trainer=nothing, commute=nothing, mediaType=nothing) -> DetailedActivity, OpenAPI.Clients.ApiResponse <br/> createactivity(api::ActivitiesApi, responsestream::Channel, name::String, sporttype::String, startdatelocal::ZonedDateTime, elapsedtime::Int64; type=nothing, description=nothing, distance=nothing, trainer=nothing, commute=nothing, _mediaType=nothing) -> Channel{ DetailedActivity }, OpenAPI.Clients.ApiResponse
Create an Activity
Creates a manual activity for an athlete, requires activity:write scope.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| name | String | The name of the activity. | |
| sport_type | String | Sport type of activity. For example - Run, MountainBikeRide, Ride, etc. | |
| startdatelocal | ZonedDateTime | ISO 8601 formatted date time. | |
| elapsed_time | Int64 | In seconds. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | String | Type of activity. For example - Run, Ride etc. | [default to nothing] |
| description | String | Description of the activity. | [default to nothing] |
| distance | Float32 | In meters. | [default to nothing] |
| trainer | Int64 | Set to 1 to mark as a trainer activity. | [default to nothing] |
| commute | Int64 | Set to 1 to mark as commute. | [default to nothing] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getactivityby_id
getactivitybyid(api::ActivitiesApi, id::Int64; includeallefforts=nothing, mediaType=nothing) -> DetailedActivity, OpenAPI.Clients.ApiResponse <br/> getactivitybyid(api::ActivitiesApi, responsestream::Channel, id::Int64; includeallefforts=nothing, _mediaType=nothing) -> Channel{ DetailedActivity }, OpenAPI.Clients.ApiResponse
Get Activity
Returns the given activity that is owned by the authenticated athlete. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| includeallefforts | Bool | To include all segments efforts. | [default to nothing] |
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]
getcommentsbyactivityid
getcommentsbyactivityid(api::ActivitiesApi, id::Int64; page=nothing, perpage=nothing, pagesize=nothing, aftercursor=nothing, mediaType=nothing) -> Vector{Comment}, OpenAPI.Clients.ApiResponse <br/> getcommentsbyactivityid(api::ActivitiesApi, responsestream::Channel, id::Int64; page=nothing, perpage=nothing, pagesize=nothing, aftercursor=nothing, _mediaType=nothing) -> Channel{ Vector{Comment} }, OpenAPI.Clients.ApiResponse
List Activity Comments
Returns the comments on the given activity. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Int64 | Deprecated. Prefer to use after_cursor. | [default to nothing] |
| per_page | Int64 | Deprecated. Prefer to use page_size. | [default to 30] |
| page_size | Int64 | Number of items per page. Defaults to 30. | [default to 30] |
| after_cursor | String | Cursor of the last item in the previous page of results, used to request the subsequent page of results. When omitted, the first page of results is fetched. | [default to nothing] |
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]
getkudoersbyactivityid
getkudoersbyactivityid(api::ActivitiesApi, id::Int64; page=nothing, perpage=nothing, mediaType=nothing) -> Vector{SummaryAthlete}, OpenAPI.Clients.ApiResponse <br/> getkudoersbyactivityid(api::ActivitiesApi, responsestream::Channel, id::Int64; page=nothing, perpage=nothing, _mediaType=nothing) -> Channel{ Vector{SummaryAthlete} }, OpenAPI.Clients.ApiResponse
List Activity Kudoers
Returns the athletes who kudoed an activity identified by an identifier. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Int64 | Page number. Defaults to 1. | [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]
getlapsbyactivityid
getlapsbyactivityid(api::ActivitiesApi, id::Int64; _mediaType=nothing) -> Vector{Lap}, OpenAPI.Clients.ApiResponse <br/> getlapsbyactivityid(api::ActivitiesApi, response_stream::Channel, id::Int64; _mediaType=nothing) -> Channel{ Vector{Lap} }, OpenAPI.Clients.ApiResponse
List Activity Laps
Returns the laps of an activity identified by an identifier. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
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]
getloggedinathleteactivities
getloggedinathleteactivities(api::ActivitiesApi; before=nothing, after=nothing, page=nothing, perpage=nothing, mediaType=nothing) -> Vector{SummaryActivity}, OpenAPI.Clients.ApiResponse <br/> getloggedinathleteactivities(api::ActivitiesApi, responsestream::Channel; before=nothing, after=nothing, page=nothing, perpage=nothing, _mediaType=nothing) -> Channel{ Vector{SummaryActivity} }, OpenAPI.Clients.ApiResponse
List Athlete Activities
Returns the activities of an athlete for a specific identifier. Requires activity:read. Only Me activities will be filtered out unless requested by a token with activity:read_all.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| before | Int64 | An epoch timestamp to use for filtering activities that have taken place before a certain time. | [default to nothing] |
| after | Int64 | An epoch timestamp to use for filtering activities that have taken place after a certain time. | [default to nothing] |
| page | Int64 | Page number. Defaults to 1. | [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]
getzonesbyactivityid
getzonesbyactivityid(api::ActivitiesApi, id::Int64; _mediaType=nothing) -> Vector{ActivityZone}, OpenAPI.Clients.ApiResponse <br/> getzonesbyactivityid(api::ActivitiesApi, response_stream::Channel, id::Int64; _mediaType=nothing) -> Channel{ Vector{ActivityZone} }, OpenAPI.Clients.ApiResponse
Get Activity Zones
Summit Feature. Returns the zones of a given activity. Requires activity:read for Everyone and Followers activities. Requires activity:read_all for Only Me activities.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
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]
updateactivityby_id
updateactivitybyid(api::ActivitiesApi, id::Int64; body=nothing, mediaType=nothing) -> DetailedActivity, OpenAPI.Clients.ApiResponse <br/> updateactivitybyid(api::ActivitiesApi, responsestream::Channel, id::Int64; body=nothing, _mediaType=nothing) -> Channel{ DetailedActivity }, OpenAPI.Clients.ApiResponse
Update Activity
Updates the given activity that is owned by the authenticated athlete. Requires activity:write. Also requires activity:read_all in order to update Only Me activities
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | ActivitiesApi | API context | |
| id | Int64 | The identifier of the activity. |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | UpdatableActivity |
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]