指定したユーザーまたは会社全体の過去のイベントを最大1年間遡って返します。
デフォルトでは、認証済みユーザーのイベントが返されます。Enterprise全体のイベントを取得するには、stream_type
をadmin_logs_streaming
に設定して新しいイベントをライブで監視するか、admin_logs
に設定してイベントの履歴を照会します。このAPIコールを行うユーザーは管理者権限を所有していること、アプリケーションではmanage enterprise properties
スコープが確認されていることが必要になります。
2012-12-12T10:53:43-08:00
イベントを返す日時の下限。stream_type
がadmin_logs
のイベントをリクエストする場合にのみ使用できます。stream_type
がこれ以外の場合、この値は無視されます。
2013-12-12T10:53:43-08:00
イベントを返す日時の上限。stream_type
がadmin_logs
のイベントをリクエストする場合にのみ使用できます。stream_type
がこれ以外の場合、この値は無視されます。
ACCESS_GRANTED
フィルタとして使用するイベントのコンマ区切りリスト。stream_type
がadmin_logs
またはadming_logs_streaming
のイベントをリクエストする場合にのみ使用できます。stream_type
がその他の場合、この値は無視されます。
50
100
500
返されるイベントの数を制限します
注: まだイベントが残っているときでも、返されるイベントの数がリクエストされた制限を下回る場合があります。これは主に、多数のイベントがすでに取得されていて、他に結果があるかどうかを確認するためにこの取得したイベントが先延ばしせずに返される場合に発生します。
1348790499819
イベントの受け入れを開始するイベントストリーム内の位置。
now
を指定すると、初期化のために空のリストイベントとともに最新のストリーム位置が返されます。0
またはnull
を指定すると、すべてのイベントが返されます。all
"all"
返されるイベントのタイプを定義します
all
を指定すると、ユーザーに関するすべてのイベントが返されます (デフォルト)。changes
を指定すると、ファイルの更新やコラボレーションなど、ファイルツリーを変更する可能性があるイベントが返されます。sync
はchanges
に似ていますが、同期対象フォルダのみに適用されますadmin_logs
を指定すると、Enterprise全体のイベントがすべて返されるほか、このAPIコールを行うユーザーには管理者権限が必要になります。このストリームタイプは、Enterprise内の全ユーザーの1年分のイベント履歴やcreated_after
からcreated_before
までの期間内のイベントをプログラムによってプルすることを目的とします。履歴に含まれるすべてのイベントは、イベントの時刻に基づいて時系列で返されますが、レイテンシはadmin_logs_streaming
よりもかなり高くなります。admin_logs_streaming
を指定すると、Enterprise全体のイベントがすべて返されるほか、このAPIコールを行うユーザーには管理者権限が必要になります。このストリームタイプは、Enterprise内の全ユーザーの最近のイベントをポーリングすることを目的としています。レイテンシはadmin_logs
よりもかなり低くなりますが、イベントは時系列で返されず、重複を含む場合があります。次の値のいずれか1つ: all
,changes
,sync
,admin_logs
,admin_logs_streaming
curl -i -X GET "https://api.box.com/2.0/events" \
-H "authorization: Bearer <ACCESS_TOKEN>"
{
"chunk_size": 2,
"entries": [
{
"additional_details": {
"key": "value"
},
"created_at": "2022-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"event_id": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83",
"event_type": "FILE_MARKED_MALICIOUS",
"recorded_at": "2022-12-12T10:54:43-08:00",
"session_id": "70090280850c8d2a1933c1",
"source": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie",
"address": "900 Jefferson Ave, Redwood City, CA 94063",
"avatar_url": "https://www.box.com/api/avatar/large/181216415",
"created_at": "2012-12-12T10:53:43-08:00",
"job_title": "CEO",
"language": "en",
"max_upload_size": 2147483648,
"modified_at": "2012-12-12T10:53:43-08:00",
"notification_email": {
"email": "notifications@example.com",
"is_confirmed": true
},
"phone": "6509241374",
"space_amount": 11345156112,
"space_used": 1237009912,
"status": "active",
"timezone": "Africa/Bujumbura"
},
"type": "event"
}
],
"next_stream_position": 1152922976252290800
}