Interface HealthReadSamplesInput

Hierarchy

Properties

dataType: HealthDataType
startDate: string

Inclusive start instant. ISO-8601 in UTC (e.g. "2026-05-01T00:00:00Z").

endDate: string

Exclusive end instant. ISO-8601 in UTC (e.g. "2026-05-01T00:00:00Z").

limit?: number

Maximum number of samples to return per page, clamped to 1..500. If omitted, up to 100 samples are returned. To read more, paginate with cursor.

ascending?: boolean

Order by start date. Defaults to false (most recent first).

cursor?: string

Pagination cursor. Omit for the first page; to fetch the next page, pass back the nextCursor returned by the previous call. The next page continues where the last one left off — older samples when descending (default), newer when ascending.

The cursor is an opaque token — do not parse or construct it. The range is exhausted when nextCursor is absent, not when samples is empty (a page may come back empty with more data still to follow).

Generated using TypeDoc