get_wellness_data
Retrieve raw wellness records for a date range, including HRV and custom fields, to analyze athlete recovery and readiness.
Instructions
Return raw wellness records using a half-open local-date range.
start_date is inclusive and end_date_exclusive is exclusive;
end_date remains the deprecated inclusive alias. The upstream API
may return an array of records or a date-keyed object whose keys are
ISO-local dates. Empty arrays/maps are valid empty data, while null,
scalar, mixed-member, and meaningless date-map shapes are errors. All
native and custom fields, including null and zero, are preserved and
source completeness remains unknown. Consult get_metric_definitions
before interpreting fields: native hrv is rMSSD and hrvSDNN is a
separate millisecond field; generic VO2max method and custom-field units
remain unknown unless explicitly declared by the source.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No | ||
| end_date | No | ||
| timezone | No | Europe/Warsaw | |
| athlete_id | No | ||
| start_date | No | ||
| end_date_exclusive | No | ||
| include_all_fields | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| error | No | ||
| query | No | ||
| source | Yes | ||
| status | Yes | ||
| coverage | Yes | ||
| warnings | No | ||
| pagination | No | ||
| request_id | No | ||
| schema_version | No | 1.0 |