2024.10.20

【Oura Ring×Web API】日々の睡眠情報を可視化しよう！【睡眠時間, 入眠時間, etc.】

こうらく

Oura Ringと呼ばれる指輪型のスマートデバイスでは、装着するだけで日々の睡眠情報やアクティビティ情報を収集することができます。

Oura Ring

外部リンク

Ouraリング。フィットネス、ストレス、睡眠、健康を管理するスマートリング。

こちらの記事ではWeb APIを使ってアクティビティの情報を取るまでのステップをイチから紹介していますので、まずはこちらをご覧ください。

事前準備と取れるデータ

Web APIを使うためのトークン取得およびTalend API Testerでのデータ確認の方法は下記の記事の「Oura RingのWeb API」章をご覧ください。

どんなデータがとれる？

睡眠時間は下記のエンドポイントから取得します。末尾の「sleep」で取るデータを分岐しています。アクティビティデータなら、画像の赤枠が「daily_activity」になります。　

https://api.ouraring.com/v2/usercollection/sleep

Web APIのコールに成功すると、各睡眠ごとの様々なデータが取得できます。

それぞれの指標の意味は下記のページが非常に参考になります。

The Learning Canvas: 知識の彩り

外部リンク

Oura API V2: エンドポイントとデータの詳細解説 - The Learning Canvas: 知識の彩り

ここで、上記画像のmovement_30_secを見てみると数値の羅列（322112…）になっています。Web APIのドキュメントを読んでみると、これはベッドに入ってから出るまでの時間に対して30秒ごとの動きのステータスになっているようです。

数値の羅列のままだと人が見ても当然何を意味しているのか分かりづらく、秒単位で細かく表現されているにもかかわらず暗黙的に時刻の情報が含まれていて分析しづらいです。この問題について、次章でどのように加工すればよいか紹介していきます！

Pythonで加工するためのポイント

データを取得・加工するまでのスクリプトは以下です。こちらのsrcフォルダのsleep.pyを利用ください。

GitHub

外部リンク

GitHub - TaroJiroTaro/get_data_from_ouraring

前章でも述べた通り、睡眠情報には睡眠中の30秒ごとの動きのステータスおよび5分ごとの眠りの深さのステータスが数値の羅列（例：44422211111…）として表現されています。分析する上では非常に扱いづらく、人が見る上でもわかりづらいです。

紹介したスクリプトでは、これらを開始時刻と終了時刻の列に展開できるようになっています。

#-- 抜粋 --#

# movement_30_sec
for b_data in data:
    start_timestamp = datetime.datetime.strptime(b_data["bedtime_start"][:-6], '%Y-%m-%dT%H:%M:%S')
    end_timestamp = datetime.datetime.strptime(b_data["bedtime_start"][:-6], '%Y-%m-%dT%H:%M:%S') + datetime.timedelta(seconds = MOVEMENT_INTERVAL)
    for status_number in b_data["movement_30_sec"]:
        movement_30_sec["id"].append(b_data["id"])
        movement_30_sec["start_recording"].append(start_timestamp)
        movement_30_sec["end_recording"].append(end_timestamp)
        movement_30_sec["status_number"].append(status_number)
        start_timestamp = start_timestamp + datetime.timedelta(seconds = MOVEMENT_INTERVAL)
        end_timestamp = end_timestamp + datetime.timedelta(seconds = MOVEMENT_INTERVAL)
output_file_path = args.output_path + "/sleep_movement30sec_" + args.start_date + "~" + args.end_date + ".csv"
pd.DataFrame(data = movement_30_sec).to_csv(output_file_path, encoding = "utf-8", index = False)

# sleep_phase_5_min
for b_data in data:
    start_timestamp = datetime.datetime.strptime(b_data["bedtime_start"][:-6], '%Y-%m-%dT%H:%M:%S')
    end_timestamp = datetime.datetime.strptime(b_data["bedtime_start"][:-6], '%Y-%m-%dT%H:%M:%S') + datetime.timedelta(minutes = SLEEP_5_MIN_INTERVAL)
    for status_number in b_data["sleep_phase_5_min"]:
        sleep_phase_5_min["id"].append(b_data["id"])
        sleep_phase_5_min["start_recording"].append(start_timestamp)
        sleep_phase_5_min["end_recording"].append(end_timestamp)
        sleep_phase_5_min["status_number"].append(status_number)
        start_timestamp = start_timestamp + datetime.timedelta(minutes = SLEEP_5_MIN_INTERVAL)
        end_timestamp = end_timestamp + datetime.timedelta(minutes = SLEEP_5_MIN_INTERVAL)
output_file_path = args.output_path + "/sleep_sleepphase5min_" + args.start_date + "~" + args.end_date + ".csv"
pd.DataFrame(data = sleep_phase_5_min).to_csv(output_file_path, encoding = "utf-8", index = False)
loop_cnt+=1