For the complete documentation index, see llms.txt. This page is also available as Markdown.

Where do I find field definitions and enum values?

Full field-by-field definitions for every payload type are in the API reference data models section, and enum values like ActivityType are listed there too.

Full field-by-field definitions for every payload type are in the API reference data models section, and enum values like ActivityType are listed there too.

A few specifics:

  • Sample arrays (hr_samples, calorie_samples, activity_levels_samples, etc.) contain timestamped individual measurements, a granular time series rather than summaries.

  • The data_provided field is an array of data-type enum values describing what the device contributed.

  • As an example, user_max_hr_bpm is the user's maximum heart rate based on age and other factors, as determined by the provider.

Use the dashboard payload simulator to generate example payloads and inspect exact shapes.

Last updated

Was this helpful?