{"id":2189,"date":"2022-10-09T14:43:18","date_gmt":"2022-10-09T13:43:18","guid":{"rendered":"https:\/\/mywindsock.com\/page\/?page_id=2189"},"modified":"2022-10-18T17:22:55","modified_gmt":"2022-10-18T16:22:55","slug":"request","status":"publish","type":"page","link":"https:\/\/mywindsock.com\/page\/api\/metrics-api-documentation\/request\/","title":{"rendered":"Request"},"content":{"rendered":"\n

The Metrics API gives you access to cycling specific weather metrics. The processing of your request may take a few seconds. This is due to the processing and retrieval of route and forecast data. We recommend to you prefetch and store the output, or display the output asynchronously, so as to avoid page loading issues.<\/p>\n\n\n\n

Endpoint<\/h2>\n\n\n\n

POST | GET<\/p>\n\n\n\n

https:\/\/mywindsock.com\/api\/metrics\/v1\/<\/p>\n\n\n\n

Passing Credentials<\/h2>\n\n\n\n

Every request must include your access credentials. These can be passed by either in the request string. If you do not have an API Client ID you must apply here<\/a>.<\/p>\n\n\n\n

client_id<\/strong><\/p>\n\n\n\n

api_key<\/strong><\/p>\n\n\n\n

Passing Source Data<\/h2>\n\n\n\n

source<\/strong>
Required. Defines the type of source data
Allowed inputs: gpx | tcx | course | strava_segment | strava_route | strava_activity <\/p>\n\n\n\n

url<\/strong>
Required for GPX or TCX sources.<\/p>\n\n\n\n

id<\/strong>
Required for, Strava, Course or CTT sources.<\/p>\n\n\n\n

timestamp<\/strong> (unix time)
Not required for TCX files unless the TCX route is to be used as a forecast. UTC timestamp for the forecast start. Timestamps that are in the past, will source observed conditions. Timestamps in the future will source forecast conditions.<\/p>\n\n\n\n

Passing Athlete Parameters<\/h2>\n\n\n\n

For a customised forecast a Virtual Athlete must be defined. For forecasts this allows our models to calculate anticipated progress. For past rides this allows us to calculate metrics personalised to the athlete.<\/p>\n\n\n\n

va=<\/strong>JSON Virtual Athlete Object<\/p>\n\n\n\n

Virtual Athlete JSON Object<\/h3>\n\n\n\n

weight<\/strong> (float)
Required. In Kg the total weight of rider, bike and equipment combined.<\/p>\n\n\n\n

watts_up<\/strong> (float)
Power in Watts, when ascending hills.<\/p>\n\n\n\n

watts <\/strong>(float)
Required. Power in Watts, when riding on the flat.<\/p>\n\n\n\n

watts_down<\/strong> (float)
Power in Watts, when descending.<\/p>\n\n\n\n

dtl<\/strong> (float)
Expected losses from the drivetrain. Only required where power has been determined above the bicycle transmission.
Expected Value: 0-100<\/p>\n\n\n\n

cda (float)<\/strong>
The average CdA, Aerodynamic efficiency.
Expected Value: >0.000<\/p>\n\n\n\n

rr (float)<\/strong>
Rolling Resistnace Coefficient.
Expected Value: >0.0000<\/p>\n\n\n\n

Selecting Output<\/h2>\n\n\n\n

output (comma separated list)<\/strong><\/p>\n\n\n\n

As default the following objects will be returned, averages, minvalues, maxvalues and totals. You can customise the output by including the ‘output’ parameter in your request. Note: the ‘totals object’ is always returned.<\/p>\n\n\n\n

“&output=averages,totals” will include only the averages and totals objects.<\/p>\n\n\n\n

Available objects are:<\/p>\n\n\n\n