メインコンテンツへスキップ
GET
/
events
cURL
curl -i -X GET "https://api.box.com/2.0/events" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "chunk_size": 2,
  "next_stream_position": "1152922976252290886",
  "entries": [
    {
      "type": "event",
      "created_at": "2022-12-12T10:53:43-08:00",
      "recorded_at": "2022-12-12T10:54:43-08:00",
      "event_id": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "[email protected]"
      },
      "event_type": "FILE_MARKED_MALICIOUS",
      "session_id": "70090280850c8d2a1933c1",
      "source": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "[email protected]",
        "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": "[email protected]",
          "is_confirmed": true
        }
      },
      "additional_details": {
        "key": "value"
      }
    }
  ]
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

認証

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

​
stream_type
enum<string>
デフォルト: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よりもかなり低くなりますが、イベントは時系列で返されず、重複を含む場合があります。
利用可能なオプション:
all,
changes,
sync,
admin_logs,
admin_logs_streaming
​
stream_position
string

イベントの受け入れを開始するイベントストリーム内の位置。

  • nowを指定すると、初期化のために空のリストイベントとともに最新のストリーム位置が返されます。
  • 0またはnullを指定すると、すべてのイベントが返されます。
​
limit
integer<int64>
デフォルト:100

返されるイベントの数を制限します。

注: まだイベントが残っているときでも、返されるイベントの数がリクエストされた制限を下回る場合があります。これは主に、多数のイベントがすでに取得されていて、他に結果があるかどうかを確認するためにこの取得したイベントが先延ばしせずに返される場合に発生します。

必須範囲: x <= 500
​
event_type
enum<string>[]

フィルタとして使用するイベントのコンマ区切りリスト。stream_typeがadmin_logsまたはadming_logs_streamingのイベントをリクエストする場合にのみ使用できます。stream_typeがその他の場合、この値は無視されます。

フィルタに使用できるイベントタイプ。

利用可能なオプション:
ACCESS_GRANTED,
ACCESS_REVOKED,
ADD_DEVICE_ASSOCIATION,
ADD_LOGIN_ACTIVITY_DEVICE,
ADMIN_LOGIN,
APPLICATION_CREATED,
APPLICATION_PUBLIC_KEY_ADDED,
APPLICATION_PUBLIC_KEY_DELETED,
CHANGE_ADMIN_ROLE,
CHANGE_FOLDER_PERMISSION,
COLLABORATION_ACCEPT,
COLLABORATION_EXPIRATION,
COLLABORATION_INVITE,
COLLABORATION_REMOVE,
COLLABORATION_ROLE_CHANGE,
COMMENT_CREATE,
COMMENT_DELETE,
CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY,
CONTENT_WORKFLOW_AUTOMATION_ADD,
CONTENT_WORKFLOW_AUTOMATION_DELETE,
CONTENT_WORKFLOW_POLICY_ADD,
CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION,
CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION,
COPY,
DATA_RETENTION_CREATE_RETENTION,
DATA_RETENTION_REMOVE_RETENTION,
DELETE,
DELETE_USER,
DEVICE_TRUST_CHECK_FAILED,
DOWNLOAD,
EDIT,
EDIT_USER,
EMAIL_ALIAS_CONFIRM,
EMAIL_ALIAS_REMOVE,
ENTERPRISE_APP_AUTHORIZATION_UPDATE,
EXTERNAL_COLLAB_SECURITY_SETTINGS,
FAILED_LOGIN,
FILE_MARKED_MALICIOUS,
FILE_WATERMARKED_DOWNLOAD,
GROUP_ADD_ITEM,
GROUP_ADD_USER,
GROUP_CREATION,
GROUP_DELETION,
GROUP_EDITED,
GROUP_REMOVE_ITEM,
GROUP_REMOVE_USER,
ITEM_EMAIL_SEND,
ITEM_MODIFY,
ITEM_OPEN,
ITEM_SHARED_UPDATE,
ITEM_SYNC,
ITEM_UNSYNC,
LEGAL_HOLD_ASSIGNMENT_CREATE,
LEGAL_HOLD_ASSIGNMENT_DELETE,
LEGAL_HOLD_POLICY_CREATE,
LEGAL_HOLD_POLICY_DELETE,
LEGAL_HOLD_POLICY_UPDATE,
LOCK,
LOGIN,
METADATA_INSTANCE_CREATE,
METADATA_INSTANCE_DELETE,
METADATA_INSTANCE_UPDATE,
METADATA_TEMPLATE_CREATE,
METADATA_TEMPLATE_DELETE,
METADATA_TEMPLATE_UPDATE,
MOVE,
NEW_USER,
OAUTH2_ACCESS_TOKEN_REVOKE,
PREVIEW,
REMOVE_DEVICE_ASSOCIATION,
REMOVE_LOGIN_ACTIVITY_DEVICE,
RENAME,
RETENTION_POLICY_ASSIGNMENT_ADD,
SHARE,
SHARED_LINK_SEND,
SHARE_EXPIRATION,
SHIELD_ALERT,
SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED,
SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION,
SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED,
SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION,
SHIELD_JUSTIFICATION_APPROVAL,
SHIELD_SHARED_LINK_ACCESS_BLOCKED,
SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE,
SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE,
SIGN_DOCUMENT_ASSIGNED,
SIGN_DOCUMENT_CANCELLED,
SIGN_DOCUMENT_COMPLETED,
SIGN_DOCUMENT_CONVERTED,
SIGN_DOCUMENT_CREATED,
SIGN_DOCUMENT_DECLINED,
SIGN_DOCUMENT_EXPIRED,
SIGN_DOCUMENT_SIGNED,
SIGN_DOCUMENT_VIEWED_BY_SIGNED,
SIGNER_DOWNLOADED,
SIGNER_FORWARDED,
STORAGE_EXPIRATION,
TASK_ASSIGNMENT_CREATE,
TASK_ASSIGNMENT_DELETE,
TASK_ASSIGNMENT_UPDATE,
TASK_CREATE,
TASK_UPDATE,
TERMS_OF_SERVICE_ACCEPT,
TERMS_OF_SERVICE_REJECT,
UNDELETE,
UNLOCK,
UNSHARE,
UPDATE_COLLABORATION_EXPIRATION,
UPDATE_SHARE_EXPIRATION,
UPLOAD,
USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE,
WATERMARK_LABEL_CREATE,
WATERMARK_LABEL_DELETE
​
created_after
string<date-time>

イベントを返す日時の下限。stream_typeがadmin_logsのイベントをリクエストする場合にのみ使用できます。stream_typeがこれ以外の場合、この値は無視されます。

​
created_before
string<date-time>

イベントを返す日時の上限。stream_typeがadmin_logsのイベントをリクエストする場合にのみ使用できます。stream_typeがこれ以外の場合、この値は無視されます。

レスポンス

イベントオブジェクトのリストを返します。

イベントオブジェクトは複数のページで返され、各ページ (チャンク) にイベントオブジェクトのリストが含まれます。レスポンスには、このチャンクで返されたイベント数を示すchunk_sizeパラメータに加え、クエリできる次のstream_positionが含まれます。

イベントオブジェクトのリスト。

​
chunk_size
integer<int64>

このレスポンスで返されるイベントの数。

例:

2

​
next_stream_position

次のイベントページ (チャンク) のストリーム開始位置。

例:

"1152922976252290886"

​
entries
Event · object[]

イベントのリスト。