技術情報
Sigfoxクラウドのメッセージはいつまで確認できる?(Message Historyの表示期間)
2022.02.25
「メッセージはSigfoxクラウドからいつでも取得できるんでしょ?」
「Sigfoxクラウドにあった過去のメッセージが消えているんだけど、なんで?」
このような疑問を持たれている方も多いのではないでしょうか。
Sigfoxクラウドではメッセージの閲覧(取得)期間が設定されており、期間が過ぎるとメッセージが閲覧できなくなります。
また、今後Sigfoxクラウドの負荷軽減のため、段階的にメッセージの閲覧期間が短くなっていきます。
本記事ではそのようなメッセージの閲覧期間にまつわる内容の説明やメッセージ取得方法について説明していきます。
メッセージ履歴の表示期間
クラウドに表示されているデバイスからのメッセージ履歴(Message History)は
表示期間を過ぎると確認できなくなります。
Sigfoxクラウドは、ご利用デバイスの増加に伴う負荷軽減を目的として、段階的にMessage History表示期間の短縮化を実施していきます。
下記のステップで閲覧可能なMessageの期間が変更となります。
➀2022年1月16日以前にMessage Historyを閲覧した場合
確認した日より、過去1年間までのMessage Historyが確認できます。
②2022年1月17日以降にMessage Historyを閲覧した場合
確認した日より当月+過去3ヶ月までMessage Historyが確認できます。
2022年2月20日にMessage Historyを閲覧した場合、ユーザーは2021年11月1日9:00(JST)から2022年2月20日までの履歴を閲覧できます。
③2022年5月10日以降にMessage Historyを閲覧した場合
確認した日より当月+過去1ヶ月までMessage Historyが確認できます。
2022年7月20日にMessage Historyを閲覧した場合、ユーザーは2022年6月1日9:00(JST)から2022年7月20日までの履歴を閲覧できます。
メッセージの削除タイミング
閲覧期間が過ぎたメッセージはいつ削除されるのか気になる方もいるかと思います。
閲覧期間を過ぎたメッセージは、毎月の月初(初日)の17:00~18:00(JST)の間にクラウドから削除されます。
※この削除タイミングはあくまで指標であり、お約束するものではありません。
そのため、 Message Historyよりメッセージの取得が必要な方は削除される前にメッセージの取得を行う必要があります。
メッセージが削除される前に取得するには?
メッセージが削除される前にMessage Historyで閲覧出来るメッセージを取得したい。
そういう方は以下の方法にてメッセージをcsv形式で取得することが可能です。
・csvによるメッセージ取得方法
1.Sigfoxクラウドで該当DeviceのMessageを選択する。
2.画面右側のcsvアイコンを選択する。
3.Export device messages画面よりExport modeをAllに変更する。
All:リストより選択した項目をダウンロード可能(最大5万件)
※Message Historyで閲覧できない、削除されたメッセージは取得することができません。
4.Exportを選択する。
Export後、ご利用されているアカウントのEmail宛にダウンロード用のメールが届き、
メール本文に記載のURLより取得したメッセージをcsv形式でダウンロードすることができます。
Message Historyにオレンジマークが表示されている場合
Message HistoryのCallback status情報がオレンジマークに変わっている場合、Callback status情報の閲覧期限を過ぎたメッセージであるといえます。
Callback status情報は、過去3ヶ月間を過ぎた時点でSigfoxクラウド上より削除されます。
Callback status情報が削除されたMessageのアイコンはオレンジ表示となり、マウスオーバーすると “Information not available”表示となります。
この状態は、Message Historyの閲覧期間中であるが、Callback status情報が削除された状態です。
・2022年5月10日以前にCallback status情報を閲覧した場合
2022年5月10日以前は下に示す通り、 Message Historyの閲覧期間中(当月+過去3ヶ月のメッセージ)であっても、過去3ヶ月間を過ぎたCallback status情報は削除され、閲覧できなくなります。
2022年2月20日14:00(JST)にCallback status情報を閲覧した場合、ユーザーは2022年11月20日14:00(JST)から2022年2月20日14:00(JST)までのCallback status情報を閲覧できます。
11月1日9:00(JST)から2022年11月20日13:59(JST)までのCallback status情報は閲覧ができなくなります。
・2022年5月10日以降にCallback status情報を閲覧した場合
2022年5月10日以降は下に示す通り、過去1ヶ月を過ぎたCallback status情報は削除され、閲覧できなくなります。
2022年7月20日14:00(JST)にCallback status情報を閲覧した場合、ユーザーは2022年6月20日14:00(JST)から2022年7月20日14:00(JST)までのCallback status情報を閲覧できます。 6月1日9:00(JST)から2022年6月20日13:59(JST)までのCallback status情報は閲覧ができなくなります。
APIによるメッセージの取得方法
Message Historyで閲覧できるメッセージはAPIにより過去30日間分のメッセージのみ取得することができます。
APIでは定期実行を行うことで定期的な取得を行うことができるほか、指定日を設定することでMessage Historyから特定期間のメッセージを取得することも可能となっています。
・APIによるメッセージ取得方法
APIによりデバイスのメッセージを取得する場合、下記GETリクエストにBasic認証を付加することでメッセージを取得することが可能です。(最大100件)
https://api.sigfox.com/v2/devices/{デバイスID}/messages
※{デバイスID}のところは、メッセージを取得したいデバイスのID
その他、取得期間の指定やfieldsパラメータによる、詳細なデータの取得方法につきましてはSigfox API Documentationにまとめられています。
例えば、指定日時以降のデータを取得したい場合、QUERY PARAMETERSのsinceを追加することでMessage Historyから特定期間のデータを取得することが可能となります。
https://api.sigfox.com/v2/devices/{デバイスID}/messages?since={指定日時}
※{指定日時}のところは、UNIX時間(ミリ秒)で指定
また、指定日時以前のデータを取得したい場合、QUERY PARAMETERSのbeforeを追加することでMessage Historyから特定期間のデータを取得することが可能となります。
https://api.sigfox.com/v2/devices/{デバイスID}/messages?before={指定日時}