# [BETA] Sleep Insights

[BETA] Sleep Insights provides you sleep related data, including the number of interruptions that have occurred and the sleep and wake times.

Endpoint: GET /insights/v2/{network_id}/sleep
Security: ApiKey

## Path parameters:

  - `network_id` (integer, required)
    Motion Network ID (returned as 'id' by Find API calls)

## Query parameters:

  - `start_date` (string, required)
    The first date to include within the results.
    Example: "2025-03-20"

  - `end_date` (string, required)
    The last date to include within the results.
    Example: "2025-04-24"

  - `timezone` (string)
    If set, the provided value will be used to perform end of day calculations.
    Example: "America/Toronto"

## Response 200 fields (application/json):

  - `hst_interruptions` (integer)
    Household Sleep Time (HST) interruptions indicates the number of interruptions that had occurred during the sleep time.
    Example: 3

  - `sleep_time` (string)
    The timestamp that indicates when the the household is considered to be asleep.
    Example: "2025-03-19T22:00:00-04:00"

  - `wake_time` (string)
    The timestamp that indicates when the household is considered to be awake.
    Example: "2025-03-20T09:15:00-04:00"

  - `timezone` (string)
    Timezone used by the sleep and wake times.
    Example: "America/Toronto"

  - `house_day` (integer)
    A counter that tracks the day that is specific to the WiFi Motion™ network.
    Example: 20166

## Response 422 fields (application/json):

  - `type` (string)
    Type of Error that occurred.

  - `loc` (array)
    Location where the error occurred.

  - `msg` (string)
    Additional details related to the error that occurred.

  - `input` (string)
    The value that was entered into the field.

  - `ctx` (object)

  - `ctx.error` (string)