Interface HealthSample

Single sample returned by readSamples.

Hierarchy

  • HealthSample

Properties

id dataType startDate endDate value unit source?

Properties

id

id: string

Native identifier. Stable across reads — useful as a key for deduplication across paginated queries.

dataType

dataType: HealthDataType

startDate

startDate: string

ISO-8601 instant in UTC (e.g. "2026-05-17T10:00:00Z").

endDate

endDate: string

ISO-8601 instant in UTC (e.g. "2026-05-17T10:00:00Z").

value

value: number

Sample value in the canonical unit declared by unit.

unit

unit: string

Canonical unit of value (e.g. "count", "m", "kcal", "bpm", "kg", "°C"). See the table in HealthDataType for the unit per data type.

Optional source

source?: HealthSourceInfo
changelog

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc