Activities¶
-
GET
/api/activities
¶ Get activities for the authenticated user.
Example requests:
without parameters
GET /api/activities/ HTTP/1.1
with some query parameters
GET /api/activities?from=2019-07-02&to=2019-07-31&sport_id=1 HTTP/1.1
Example responses:
returning at least one activity
HTTP/1.1 200 OK Content-Type: application/json { "data": { "activities": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "ascent": null, "ave_speed": 10.0, "bounds": [], "creation_date": "Sun, 14 Jul 2019 13:51:01 GMT", "descent": null, "distance": 10.0, "duration": "0:17:04", "id": 1, "map": null, "max_alt": null, "max_speed": 10.0, "min_alt": null, "modification_date": null, "moving": "0:17:04", "next_activity": 3, "notes": null, "pauses": null, "previous_activity": null, "records": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 4, "record_type": "MS", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 3, "record_type": "LD", "sport_id": 1, "user": "admin", "value": "0:17:04" }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 2, "record_type": "FD", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 1, "record_type": "AS", "sport_id": 1, "user": "admin", "value": 10.0 } ], "segments": [], "sport_id": 1, "title": null, "user": "admin", "weather_end": null, "weather_start": null, "with_gpx": false } ] }, "status": "success" }
returning no activities
HTTP/1.1 200 OK Content-Type: application/json { "data": { "activities": [] }, "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
- Query Parameters
page (integer) – page if using pagination (default: 1)
per_page (integer) – number of activities per page (default: 5)
sport_id (integer) – sport id
from (string) – start date (format:
%Y-%m-%d
)to (string) – end date (format:
%Y-%m-%d
)distance_from (float) – minimal distance
distance_to (float) – maximal distance
duration_from (string) – minimal duration (format:
%H:%M
)duration_to (string) – maximal distance (format:
%H:%M
)ave_speed_from (float) – minimal average speed
ave_speed_to (float) – maximal average speed
max_speed_from (float) – minimal max. speed
max_speed_to (float) – maximal max. speed
order (string) – sorting order (default:
desc
)
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
-
GET
/api/activities/
(int: activity_id)¶ Get an activity
Example request:
GET /api/activities/3 HTTP/1.1
Example responses:
success
HTTP/1.1 200 OK Content-Type: application/json { "data": { "activities": [ { "activity_date": "Sun, 07 Jul 2019 07:00:00 GMT", "ascent": null, "ave_speed": 16, "bounds": [], "creation_date": "Sun, 14 Jul 2019 18:57:14 GMT", "descent": null, "distance": 12, "duration": "0:45:00", "id": 3, "map": null, "max_alt": null, "max_speed": 16, "min_alt": null, "modification_date": "Sun, 14 Jul 2019 18:57:22 GMT", "moving": "0:45:00", "next_activity": 4, "notes": "activity without gpx", "pauses": null, "previous_activity": 3, "records": [], "segments": [], "sport_id": 1, "title": "biking on sunday morning", "user": "admin", "weather_end": null, "weather_start": null, "with_gpx": false } ] }, "status": "success" }
acitivity not found:
HTTP/1.1 404 NOT FOUND Content-Type: application/json { "data": { "activities": [] }, "status": "not found" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
403 Forbidden – You do not have permissions.
404 Not Found – activity not found
-
POST
/api/activities
¶ Post an activity with a gpx file
Example request:
POST /api/activities/ HTTP/1.1 Content-Type: multipart/form-data
Example response:
HTTP/1.1 201 CREATED Content-Type: application/json { "data": { "activities": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "ascent": null, "ave_speed": 10.0, "bounds": [], "creation_date": "Sun, 14 Jul 2019 13:51:01 GMT", "descent": null, "distance": 10.0, "duration": "0:17:04", "id": 1, "map": null, "max_alt": null, "max_speed": 10.0, "min_alt": null, "modification_date": null, "moving": "0:17:04", "next_activity": 3, "notes": null, "pauses": null, "previous_activity": null, "records": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 4, "record_type": "MS", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 3, "record_type": "LD", "sport_id": 1, "user": "admin", "value": "0:17:04" }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 2, "record_type": "FD", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 1, "record_type": "AS", "sport_id": 1, "user": "admin", "value": 10.0 } ], "segments": [], "sport_id": 1, "title": null, "user": "admin", "weather_end": null, "weather_start": null, "with_gpx": false } ] }, "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
- Form Parameters
file – gpx file (allowed extensions: .gpx, .zip)
data – sport id and notes (example:
{"sport_id": 1, "notes": ""}
)
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
201 Created – activity created
Invalid payload.
No file part.
No selected file.
File extension not allowed.
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
413 Request Entity Too Large – Error during picture update: file size exceeds 1.0MB.
-
POST
/api/activities/no_gpx
¶ Post an activity without gpx file
Example request:
POST /api/activities/no_gpx HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 201 CREATED Content-Type: application/json { "data": { "activities": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "ascent": null, "ave_speed": 10.0, "bounds": [], "creation_date": "Sun, 14 Jul 2019 13:51:01 GMT", "descent": null, "distance": 10.0, "duration": "0:17:04", "id": 1, "map": null, "max_alt": null, "max_speed": 10.0, "min_alt": null, "modification_date": null, "moving": "0:17:04", "next_activity": 3, "notes": null, "pauses": null, "previous_activity": null, "records": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 4, "record_type": "MS", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 3, "record_type": "LD", "sport_id": 1, "user": "admin", "value": "0:17:04" }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 2, "record_type": "FD", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 1, "record_type": "AS", "sport_id": 1, "user": "admin", "value": 10.0 } ], "segments": [], "sport_id": 1, "title": null, "user": "admin", "weather_end": null, "weather_start": null, "with_gpx": false } ] }, "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
- Request JSON Object
activity_date (string) – activity date (format:
%Y-%m-%d %H:%M
)distance (float) – activity distance in km
duration (integer) – activity duration in seconds
notes (string) – notes (not mandatory)
sport_id (integer) – activity sport id
title (string) – activity title
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
201 Created – activity created
400 Bad Request – invalid payload
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
-
PATCH
/api/activities/
(int: activity_id)¶ Update an activity
Example request:
PATCH /api/activities/1 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": { "activities": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "ascent": null, "ave_speed": 10.0, "bounds": [], "creation_date": "Sun, 14 Jul 2019 13:51:01 GMT", "descent": null, "distance": 10.0, "duration": "0:17:04", "id": 1, "map": null, "max_alt": null, "max_speed": 10.0, "min_alt": null, "modification_date": null, "moving": "0:17:04", "next_activity": 3, "notes": null, "pauses": null, "previous_activity": null, "records": [ { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 4, "record_type": "MS", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 3, "record_type": "LD", "sport_id": 1, "user": "admin", "value": "0:17:04" }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 2, "record_type": "FD", "sport_id": 1, "user": "admin", "value": 10.0 }, { "activity_date": "Mon, 01 Jan 2018 00:00:00 GMT", "activity_id": 1, "id": 1, "record_type": "AS", "sport_id": 1, "user": "admin", "value": 10.0 } ], "segments": [], "sport_id": 1, "title": null, "user": "admin", "weather_end": null, "weather_start": null, "with_gpx": false } ] }, "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
- Request JSON Object
activity_date (string) – activity date (format:
%Y-%m-%d %H:%M
) (only for activity without gpx)distance (float) – activity distance in km (only for activity without gpx)
duration (integer) – activity duration in seconds (only for activity without gpx)
notes (string) – notes
sport_id (integer) – activity sport id
title (string) – activity title
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – activity updated
400 Bad Request – invalid payload
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found
-
DELETE
/api/activities/
(int: activity_id)¶ Delete an activity
Example request:
DELETE /api/activities/1 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 204 NO CONTENT Content-Type: application/json
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
204 No Content – activity deleted
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found
500 Internal Server Error – Error. Please try again or contact the administrator.
-
GET
/api/activities/map/
(map_id)¶ Get map image for activities with gpx
Example request:
GET /api/activities/map/fa33f4d996844a5c73ecd1ae24456ab8?1563529507772 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: image/png
- Parameters
map_id (string) – activity map id
- Status Codes
200 OK – success
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – map does not exist
-
GET
/api/activities/
(int: activity_id)/gpx
¶ Get gpx file for an activity displayed on map with Leaflet
Example request:
GET /api/activities/3/gpx HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": { "gpx": "gpx file content" }, "message": "", "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
400 Bad Request – no gpx file for this activity
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found
-
GET
/api/activities/
(int: activity_id)/chart_data
¶ Get chart data from an activity gpx file, to display it with Recharts
Example request:
GET /api/activities/3/chart HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": { "chart_data": [ { "distance": 0, "duration": 0, "elevation": 279.4, "latitude": 51.5078118, "longitude": -0.1232004, "speed": 8.63, "time": "Fri, 14 Jul 2017 13:44:03 GMT" }, { "distance": 7.5, "duration": 7380, "elevation": 280, "latitude": 51.5079733, "longitude": -0.1234538, "speed": 6.39, "time": "Fri, 14 Jul 2017 15:47:03 GMT" } ] }, "message": "", "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
400 Bad Request – no gpx file for this activity
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found
-
GET
/api/activities/
(int: activity_id)/gpx/segment/
(int: segment_id)¶ Get gpx file for an activity segment displayed on map with Leaflet
Example request:
GET /api/activities/3/gpx/segment/0 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": { "gpx": "gpx file content" }, "message": "", "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
segment_id (integer) – segment id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
400 Bad Request – no gpx file for this activity
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found
-
GET
/api/activities/
(int: activity_id)/chart_data/segment/
(int: segment_id)¶ Get chart data from an activity gpx file, to display it with Recharts
Example request:
GET /api/activities/3/chart/segment/0 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": { "chart_data": [ { "distance": 0, "duration": 0, "elevation": 279.4, "latitude": 51.5078118, "longitude": -0.1232004, "speed": 8.63, "time": "Fri, 14 Jul 2017 13:44:03 GMT" }, { "distance": 7.5, "duration": 7380, "elevation": 280, "latitude": 51.5079733, "longitude": -0.1234538, "speed": 6.39, "time": "Fri, 14 Jul 2017 15:47:03 GMT" } ] }, "message": "", "status": "success" }
- Parameters
auth_user_id (integer) – authenticate user id (from JSON Web Token)
activity_id (integer) – activity id
segment_id (integer) – segment id
- Request Headers
Authorization – OAuth 2.0 Bearer Token
- Status Codes
200 OK – success
400 Bad Request – no gpx file for this activity
Provide a valid auth token.
Signature expired. Please log in again.
Invalid token. Please log in again.
404 Not Found – activity not found