get_sleep_stage_summary: Nightly Sleep Stage Summary Data

In fitbitr: Interface with the 'Fitbit' API

Nightly Sleep Stage Summary Data

Description

Returns a tibble of nightly sleep stage data. Minutes in each stage, count of times in each stage, and a thirty day average for the number of minutes in each stage.

Usage

get_sleep_stage_summary(start_date, end_date = start_date)

Arguments

start_date	The start date of records to be returned in "yyyy-mm-dd" or date(time) format
end_date	The end date of records to be returned in "yyyy-mm-dd" or date(time) format

Value

A tibble of a variety of sleep stage summary data, by day

Examples

## Not run: 
start_date <- lubridate::today() - lubridate::weeks(1)
end_date <- lubridate::today()

get_sleep_stage_summary(start_date, end_date)

## End(Not run)

fitbitr documentation built on March 31, 2023, 9:10 p.m.