get_metric_definitions
Get definitions and field details for Intervals.icu metric names before interpreting activity, wellness, or custom data. Select specific names or fields, or view the curated catalogue.
Instructions
Explain selected metric names and fields from the local catalogue.
Use this before interpreting activity streams, intervals, wellness, or
custom-item content. Selectors are optional; omitting both returns the
small curated catalogue. Units, sample-index versus time axes, upstream
reported/calculated/estimated status, and limitations are descriptive only.
No account data is fetched, no training calculation is performed, and
unknown selectors remain explicit in unknown_names.
Includes VT/tidal_volume, VE/tidal_volume_min and BR/respiration with Tymewear FIT mappings and device-unit context. Tymewear volume is relative, not calibrated liters; do not divide raw VT by 100 or 1000. VT is volume per breath, distinct from thresholds VT1/VT2. Custom names/units require source verification; this catalogue does not identify a recording's device.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| names | No | ||
| 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 |