Submitting Sleep to Inform Connect

🔍
This guide is for Inform Data Source Partners.
If you are a Validic Inform Client and you are looking for more information on how to use the Inform APIs to retrieve your end users' data, please review the Inform API Quick Start Guide instead of this one.

The sleep endpoint provides a record of completed sleep events.

The sleep object records information about a single time-based sleep event, including summary information about the sleep (for example duration, time asleep, time awake for the entire sleep).

📘
A user can have many sleeps per Data Source for a given day. Each submitted event represents a completed sleep event.

There may be more than one sleep event per day if the data source supports that behavior (such as nap tracking).

Sample Sleep POST

{
    "log_id": "validic-test-sleep-record-1",
    "start_time": "2025-02-24T12:30:09Z",
    "end_time": "2025-02-24T12:30:09Z",
    "utc_offset": -18000,
    "offset_origin": "source",
    "metrics": [
        {
                    "type": "rem_sleep",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 1620.0
                },
                {
                    "type": "awake_duration",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 2880.0
                },
                {
                    "type": "light_sleep",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 6600.0
                },
                {
                    "type": "deep_sleep",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 7140.0
                },
                {
                    "type": "awake_count",
                    "origin": "unknown",
                    "unit": "count",
                    "value": 0
                },
                {
                    "type": "time_to_fall_asleep",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 2160.0
                },
                {
                    "type": "sleep_duration",
                    "origin": "unknown",
                    "unit": "s",
                    "value": 15360.0
                }
    ],
    "source": {
        "type": "validic_connect_test",
        "device": {
            "id": null,
            "model": "Validic App",
            "manufacturer": "Validic Inc."
        }
    },
    "type": "sleep",
    "version": "1.0"
}