ユーザーおよび会社のイベントのリストを取得
指定したユーザーまたは会社全体の過去のイベントを最大1年間遡って返します。
デフォルトでは、認証済みユーザーのイベントを返します。会社全体のイベントを取得するには、stream_typeをadmin_logsに設定します。会社のイベントフィードを取得するには、API呼び出しを行うユーザーが管理者権限を所有していて、アプリケーションがイベントフィードに対するアクセス権限を所有している必要があります。
リクエスト
Bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string / date-timeクエリ内省略可能
2012-12-12T10:53:43-08:00イベントを返す日時の下限。stream_typeがadmin_logsのイベントをリクエストする場合にのみ使用できます。stream_typeがこれ以外の場合、この値は無視されます。
string / date-timeクエリ内省略可能
2013-12-12T10:53:43-08:00イベントを返す日時の上限。stream_typeがadmin_logsのイベントをリクエストする場合にのみ使用できます。stream_typeがこれ以外の場合、この値は無視されます。
string arrayクエリ内省略可能
ACCESS_GRANTEDフィルタとして使用するイベントのカンマ区切りリスト。stream_typeがadmin_logsのイベントをリクエストする場合にのみ使用できます。stream_typeがこれ以外の場合、この値は無視されます。
integer / int64クエリ内省略可能
50100500返されるイベントの数を制限します
stringクエリ内省略可能
1348790499819イベントの受け入れを開始するイベントストリーム内の位置。
nowを指定すると、初期化のための空のリストイベントとともに、最新のストリーム位置が返されます。0またはnullを指定すると、すべてのイベントが返されます。
stringクエリ内省略可能
all"all"返されるイベントのタイプを定義します
allの場合は、ユーザーに関するすべてのイベントを返します(デフォルト値)changesの場合は、ファイルのアップロードやコラボレーションなど、ファイルのツリー構造が変わる可能性があるイベントを返しますsyncはchangesと似ていますが、同期対象フォルダのみに適用されますadmin_logsの場合は、会社全体のすべてのイベントを返します。API呼び出しを行うユーザーは、管理者権限が必要です。
次の値のいずれか1つ: all,changes,sync,admin_logs
リクエストの例
cURL
curl -X GET https://api.box.com/2.0/events \
-H 'Authorization: Bearer <ACCESS_TOKEN>'Python
stream_position = 0
events = client.events().get_events(stream_position=stream_position)
stream_position = events['next_stream_position']
for event in events['entries']:
print('Got {0} event that occurred at {1}'.format(event.event_type, event.created_at))Node
client.events.get({stream_position: '1408838928446360'}, callback);レスポンスの例
{
"chunk_size": 2,
"entries": [
{
"type": "event",
"event_id": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83",
"created_by": {
"id": 11446498,
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"event_type": "FILE_MARKED_MALICIOUS",
"session_id": "70090280850c8d2a1933c1",
"source": {
"id": 11446498,
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"language": "en",
"timezone": "Africa/Bujumbura",
"space_amount": 11345156112,
"space_used": 1237009912,
"max_upload_size": 2147483648,
"status": "active",
"job_title": "CEO",
"phone": 6509241374,
"address": "900 Jefferson Ave, Redwood City, CA 94063",
"avatar_url": "https://www.box.com/api/avatar/large/181216415",
"notification_email": {
"email": "notifications@example.com",
"is_confirmed": true
}
},
"additional_details": {
"key": "value"
}
}
],
"next_stream_position": 1152922976252290800
}