ExOura.InterbeatInterval (ex_oura v3.0.1)

Copy Markdown View Source

API functions for retrieving Oura interbeat interval time-series data.

Summary

Types

end_datetime()
next_token()
opts()
start_datetime()

Functions

multiple_interbeat_interval(start_datetime, end_datetime, next_token \\ nil, opts \\ [])

Retrieves interbeat interval rows for a time range.

Types

end_datetime()

@type end_datetime() :: DateTime.t() | NaiveDateTime.t()

next_token()

@type next_token() :: String.t() | nil

opts()

@type opts() :: Keyword.t()

start_datetime()

@type start_datetime() :: DateTime.t() | NaiveDateTime.t()

Functions

multiple_interbeat_interval(start_datetime, end_datetime, next_token \\ nil, opts \\ [])

@spec multiple_interbeat_interval(
  start_datetime(),
  end_datetime(),
  next_token(),
  opts()
) ::
  {:ok, ExOura.Client.TimeSeriesResponsePublicInterbeatIntervalRow.t()}
  | {:error, term()}

Retrieves interbeat interval rows for a time range.