Known issues and Limitations¶
When are these fixed?
We are working on improvements all the time and hope to make the list shorter. Please let us know if some particular issue is important for you so we can take your feedback into account when prioritising our work.
Known Issues¶
-
/athletes/{athlete_id}/measurementsreturns a list of athlete measurements with aSessionIDfield. While this field indicates which Session the measurement has been added to, please note that a measurement can be added to more than one Session, but the response format can only show one SessionId. We recommend ignoring this field and instead retrieving the athlete IDs and measurement IDs linked to sessions from the session-related endpoints (sessions and session results). This will not be changed in the current version as it would cause a breaking change. -
Due to technical and historical reasons, heart rate zone variable names are inverted compared to the rest of the system. In the Cloud API, zone1 represents the highest zone (high intensity), while zone5 represents the lowest. This is a system naming convention that has been maintained for backwards compatibility. When building your UI or reports, you'll need to map zone 1 to zone 5, zone 2 to zone 4, and so on.
Limitations¶
- API returns all time fields in UTC time. Account time zone information is not available via the API, so you'll need to handle time zone conversion in your application.
- API doesn't provide webhooks to inform about updates or an endpoint to request changes since a specified date. The best solution depends on your requirements. We have outlined one approach here.
- API doesn't include information about the API consumer rate limit and API call quota settings. There isn't an endpoint to request the current quota status and it's not included in the return headers. You'll need to implement rate limit handling using your configured values and decide how to track daily quota. Alternatively, you can handle 429 responses and back off until the quota resets at midnight UTC when the API notifies that the quota has been exceeded.
- It's not possible to get measurement results in chunks - you need to retrieve results for each measurement one by one. We understand this results in a large number of API calls when processing many measurements, which can take time.
Data currently not available via the API¶
- Athlete profile details (e.g. HR zone limits, age, weight).
- Training history related variables (Acute Load, Chronic Load, ACWR) for the days that don't have any measurements.