nmelone/GoldenCheetah
1
0
Fork 0
mirror of https://github.com/GoldenCheetah/GoldenCheetah.git synced 2026-02-13 08:08:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document REST API endpoints

Browse Source 
.. need to add more narrative

[skip ci]
This commit is contained in:
Mark Liversedge
2015-11-28 09:18:21 +00:00
parent a381c17ea9
commit f4593dbc7f
1 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
doc/user/rest-api.txt Normal file
View File

@@ -0,0 +1,33 @@
http://localhost:12021 Default base URL
/ List Athletes
Returns csv of athletes and core data (dob, sex etc)
/<athlete> List Athlete Rides with Metrics and Metadata
since=yyyy/mm/dd
before=yyyy/mm/dd
metrics=NP,IF,TSS,AveragePower
metadata=none or all or list (Sport,Workout Code)
intervals=true
Returns csv of activities incl. metrics and metadata
/<athlete>/zones List Athlete Zone Config
for=xxx where xxx is one of power, hr, pace, swimpace
Returns csv of zone config history (e.g. configured CP/W')
/<athlete>/activity/<filename> Fetch activity file
format=xxx where xxx is one of csv, tcx, json, pwx
Returns ride file data in the requested format
/<athlete>/meanmax/<filename> Fetch activity Mean Max data
series=xxx where xxx is one of watts,hr,cad,speed,nm,vam.xPower,NP
Returns csv of the mean max data for a ride
/<athlete>/meanmax/bests Fetch Mean Max Bests for a Date Range
since=yyyy/mm/dd
before=yyyy/mm/dd
series=xxx where xxx is one of watts,hr,cad,speed,nm,vam.xPower,NP
Returns an aggregate of the best mean maximal values over the date range