Authorizations
Vital Team API Key
Path Parameters
The Vital Sleep ID
curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'
{
  "heartrate": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580055+00:00",
      "unit": "bpm",
      "value": 32
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580093+00:00",
      "unit": "bpm",
      "value": 125
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580128+00:00",
      "unit": "bpm",
      "value": 186
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580178+00:00",
      "unit": "bpm",
      "value": 51
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580213+00:00",
      "unit": "bpm",
      "value": 82
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.579749+00:00",
      "unit": "rmssd",
      "value": 2
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.579864+00:00",
      "unit": "rmssd",
      "value": 53
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.579918+00:00",
      "unit": "rmssd",
      "value": 58
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.579972+00:00",
      "unit": "rmssd",
      "value": 54
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580014+00:00",
      "unit": "rmssd",
      "value": 38
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580267+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580302+00:00",
      "unit": "stage",
      "value": 2
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580340+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580370+00:00",
      "unit": "stage",
      "value": 4
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580398+00:00",
      "unit": "stage",
      "value": 3
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580432+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580460+00:00",
      "unit": "bpm",
      "value": 30
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580488+00:00",
      "unit": "bpm",
      "value": 16
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580515+00:00",
      "unit": "bpm",
      "value": 28
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580540+00:00",
      "unit": "bpm",
      "value": 15
    }
  ]
}Get Sleep stream for a user_id
curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'
{
  "heartrate": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580055+00:00",
      "unit": "bpm",
      "value": 32
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580093+00:00",
      "unit": "bpm",
      "value": 125
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580128+00:00",
      "unit": "bpm",
      "value": 186
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580178+00:00",
      "unit": "bpm",
      "value": 51
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580213+00:00",
      "unit": "bpm",
      "value": 82
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.579749+00:00",
      "unit": "rmssd",
      "value": 2
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.579864+00:00",
      "unit": "rmssd",
      "value": 53
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.579918+00:00",
      "unit": "rmssd",
      "value": 58
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.579972+00:00",
      "unit": "rmssd",
      "value": 54
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580014+00:00",
      "unit": "rmssd",
      "value": 38
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580267+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580302+00:00",
      "unit": "stage",
      "value": 2
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580340+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580370+00:00",
      "unit": "stage",
      "value": 4
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580398+00:00",
      "unit": "stage",
      "value": 3
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-11-01T23:41:12.580432+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 1,
      "timestamp": "2025-11-01T23:41:42.580460+00:00",
      "unit": "bpm",
      "value": 30
    },
    {
      "id": 2,
      "timestamp": "2025-11-01T23:42:12.580488+00:00",
      "unit": "bpm",
      "value": 16
    },
    {
      "id": 3,
      "timestamp": "2025-11-01T23:42:42.580515+00:00",
      "unit": "bpm",
      "value": 28
    },
    {
      "id": 4,
      "timestamp": "2025-11-01T23:43:12.580540+00:00",
      "unit": "bpm",
      "value": 15
    }
  ]
}curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'
Vital Team API Key
The Vital Sleep ID
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?