Enterprise Eventの取得

Enterprise Eventを取得するには、stream_typeをadmin_logsまたはadmin_logs_streamingに設定してGET /events APIを呼び出します。

ストリームタイプ

ライブで監視

Box内で生成された最近のイベントをEnterprise全体で監視するには、stream_typeをadmin_logs_streamingに設定します。これは、Enterprise Event Stream APIとも呼ばれます。

このフィードでは、時系列の正確さよりもレイテンシの低さを重視しています。つまり、Boxでは、イベントが複数回、時系列に関係なく返される場合があります。イベントは、Boxで処理されるとほぼリアルタイムでAPIを介して返されます。少しの遅延やバッファが発生すると、新しいイベントがカーソル位置の後に書き込まれなくなります。このstream_typeで取得できるイベントは、2週間分だけです。

履歴の照会

Enterprise全体のイベント履歴を最大1年分照会するには、stream_typeをadmin_logsに設定します。これは、 Enterprise Event History APIとも呼ばれます。

このフィードでは、レイテンシよりも完全性を重視しています。つまり、Boxでは、管理イベントが重複することなく時系列で配信されますが、レイテンシはユーザーまたはadmin_logs_streamingのフィードよりも高くなります。イベントは、フィルタをかけている期間より後に到着する可能性があるため、ほぼリアルタイムで使用すると見逃される場合があります。

匿名ユーザー

場合によっては、イベントフィードには、IDが2のユーザーが表示される可能性があります。これは、匿名ユーザーを表すBoxの内部識別子です。

匿名ユーザーは、ログインしていないユーザーです。この状況は、ユーザーがコンテンツを操作し、最初にログインを求められない場合にいつでも発生する可能性があります。たとえば、ユーザーが、公開共有リンクを使用してファイルをダウンロードするときなどです。

制限

Enterprise Eventフィードでは、Long pollingがサポートされません。

Boxでのイベントの保存は無期限ではありません。stream_typeをadmin_logs_streamingに設定した場合は2週間分のEnterprise Event、stream_typeをadmin_logsに設定した場合は1年分のEnterprise Eventを取得できます。また、Box管理コンソールでエクスポートされるレポートでは、7年分のEnterprise Eventを取得できます。

admin_logs_streamingフィードでは、すべての結果を迅速に返すことを重視しています。つまり、Boxでは、イベントが順不同で複数回返される可能性があります。重複するイベントは、イベントIDによって識別できます。

イベントタイプによるフィルタ

Enterprise Eventフィードでは、イベントタイプによるフィルタがサポートされています。

イベントタイプの完全なリストについては、以下を参照してください。

イベントタイプ

Enterpriseに対して、以下のイベントがトリガーされます。このリストですべてを網羅しているわけではないため、記載されていないイベントが表示される可能性もあります。