data
sleep
Return sleep cycles summarized from sleep stages
Process raw sleep data samples into sleep cycles and assign by finding gaps in the sleep sample data within a specified time interval.
get/data/v0/{fulcra_userid}/sleep_cycles
Request
- Base URL: https://api.fulcradynamics.com
- URL: https://api.fulcradynamics.com/data/v0/{fulcra_userid}/sleep_cycles
- Auth: HTTP bearer
Path parameters
fulcra_useridstring uuid required
Query parameters
start_timestring date-time required
The starting timestamp in ISO8601 format (inclusive)
Example:2024-11-15 00:00:00Z
end_timestring date-time required
The ending timestamp in ISO8601 format (exclusive)
Example:2024-11-16 00:00:00Z
output'ndjson' | 'jstable' | 'jscolumns' | 'arrow' | 'arrowraw' | 'parquet' | 'csv' | 'quotecsv' required
The output format to generate.
cycle_gapstring duration
Minimum time interval separating distinct cycles.
stagesinteger[] nullable
Sleep stages to include. Defaults to all stages.
gap_stagesinteger[] nullable
Sleep stages to consider as gaps in sleep cycles.
clip_to_rangeboolean
Whether to clip the data to the requested date range. This is always done when requesting data for a user other than the authenticated user.
Response
Successful Response
unknown required
Changes
No recorded changes to this operation across all 1 revision of this API.