最新バージョン
User EventおよびEnterprise Eventのリストを取得
指定したユーザーまたは会社全体の過去のイベントを最大1年間遡って返します。
デフォルトでは、認証済みユーザーのイベントが返されます。Enterprise全体のイベントを取得するには、stream_typeをadmin_logs_streamingに設定して新しいイベントをライブで監視するか、admin_logsに設定してイベントの履歴を照会します。このAPIコールを行うユーザーは管理者権限を所有していること、アプリケーションではmanage enterprise propertiesスコープが確認されていることが必要になります。
リクエスト
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またはadming_logs_streamingのイベントをリクエストする場合にのみ使用できます。stream_typeがその他の場合、この値は無視されます。
integer (int64)クエリ内省略可能
50100500返されるイベントの数を制限します
注: まだイベントが残っているときでも、返されるイベントの数がリクエストされた制限を下回る場合があります。これは主に、多数のイベントがすでに取得されていて、他に結果があるかどうかを確認するためにこの取得したイベントが先延ばしせずに返される場合に発生します。
stringクエリ内省略可能
1348790499819イベントの受け入れを開始するイベントストリーム内の位置。
nowを指定すると、初期化の ために空のリストイベントとともに最新のストリーム位置が返されます。0またはnullを指定すると、すべてのイベントが返されます。
stringクエリ内省略可能
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
curl -i -X GET "https://api.box.com/2.0/events" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.events.getEvents({
streamType: 'admin_logs' as GetEventsQueryParamsStreamTypeField,
limit: 1,
createdAfter: createdAfterDate,
createdBefore: createdBeforeDate,
} satisfies GetEventsQueryParams);Python Gen
client.events.get_events(
stream_type=GetEventsStreamType.ADMIN_LOGS,
limit=1,
created_after=created_after_date,
created_before=created_before_date,
).NET Gen
await client.Events.GetEventsAsync(queryParams: new GetEventsQueryParams() { StreamType = GetEventsQueryParamsStreamTypeField.AdminLogs, Limit = 1, CreatedAfter = createdAfterDate, CreatedBefore = createdBeforeDate });Java
EventStream stream = new EventStream(api);
stream.addListener(new EventListener() {
public void onEvent(BoxEvent event) {
// Handle the event.
}
});
stream.start();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(f'Got {event.event_type} event that occurred at {event.created_at}').NET
BoxEventCollection<BoxEnterpriseEvent> events = await client.EventsManager.UserEventsAsync();Node
client.events.get({stream_position: '1408838928446360'}, callback);レスポンスの例
{
"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
}