Pigeon/ AlertHub のデータ保持期間について

回答済み

コメント

1件のコメント

  • Kompiraサポートチーム

    ご質問ありがとうございます。
    回答させていただきます。

    AlertHub における「履歴」について

    AlertHubにおいて1年間保持する「履歴」は下記を指します。

    • メッセージ
    • イベント
    • アクション実行履歴

    ■ メッセージ取得に関するAPI

    「メッセージ」メニューで提供しているような、分単位での期間指定、受信スロット指定、ルール実行/イベント発行の有無による検索ができるのは30日間となるため画面上では「直近30日分のメッセージが閲覧可能です」と記載させていただいておりますが、個々のメッセージの保存期間は1年間となっております。

    受信から30日間を超えたメッセージについては検索性が落ちるものの、専用のAPIより引き続き取得が可能です。具体的には、下記のAPIでの情報取得は1年間行うことができます。

    GET /api/apps/alerthub/message/detail/{messageId} メッセージ詳細の取得
    GET /api/apps/alerthub/message/list/archive/{date} メッセージアーカイブの一覧取得

    また、下記のAPIからの情報取得は30日間に限って行うことができます。

    GET /api/apps/alerthub/message/list メッセージの一覧取得
    GET /api/apps/alerthub/message/detail/{messageId}/events メッセージに関連するイベントの一覧取得
    GET /api/apps/alerthub/message/detail/{messageId}/rule-records メッセージに関連するルール実行履歴の一覧取得

    ■ イベント取得に関するAPI

    下記のAPIにより取得可能です。

    GET /api/apps/alerthub/events スペース内全イベントの一覧取得
    GET /api/apps/alerthub/scopes/{scopeId}/events イベントの一覧取得
    GET ​/api​/apps​/alerthub​/scopes​/{scopeId}​/events​/{eventId} イベントの取得

    ■ アクション実行履歴取得に関するAPI

    下記のAPIにより取得可能です。

    GET /api/apps/alerthub/action-records アクション実行履歴の一覧取得
    GET /api/apps/alerthub/action-records/{actionRecordId} アクション実行履歴の取得

     

    Pigeonにおける「履歴」について

    Pigeonにおいて6ヶ月間保持する「履歴」は下記を指します。

    • 連絡処理結果(連絡履歴)
    • 架電結果(架電履歴)

    ■ 連絡処理結果取得に関するAPI

    下記のAPIにより取得可能です。

    GET /api/apps/pigeon/results 連絡処理結果の一覧取得
    GET /api/apps/pigeon/results/{resultId} 連絡処理結果の取得

    ■ 架電結果取得に関するAPI

    個々の連絡リクエストに対して行われた一連の架電結果は先に挙げた「連絡処理結果の取得」APIにより取得可能です。

    また、下記のAPIを用いることで架電結果を連絡単位ではなく、横断的に取得することが可能です。

    GET /api/apps/pigeon/calls 架電結果の一覧取得
    GET ​/api​/apps​/pigeon​/calls​/{callId} 架電結果の取得

     

    以上、よろしくお願いいたします。

     

    0
    コメントアクション Permalink

サインインしてコメントを残してください。