Get Events

POST

https://api.dropboxapi.com/2/team_log/get_events

POST

/2/team_log/get_events

import requests
url = "https://api.dropboxapi.com/2/team_log/get_events"
payload = {
    "category": { ".tag": "groups" },
    "limit": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
  "events": [
    {
      "details": {
        ".tag": "shared_content_download_details",
        "shared_content_access_level": {
          ".tag": "traverse"
        },
        "shared_content_link": "abc",
        "shared_content_owner": {
          ".tag": "non_team_member",
          "account_id": "dbid:AAEIZtgeKLjx5uul1l65ZnNxXIfyNJ0-Ohc",
          "display_name": "John Smith",
          "email": "john_smith@acmecorp.com"
        }
      },
      "event_category": {
        ".tag": "tfa"
      },
      "event_type": {
        ".tag": "shared_content_download",
        "description": "(sharing) Downloaded shared file/folder"
      },
      "timestamp": "2017-01-25T15:51:30Z",
      "actor": {
        ".tag": "user",
        "user": {
          ".tag": "non_team_member",
          "account_id": "dbid:AAEIZtgeKLjx5uul1l65ZnNxXIfyNJ0-Ohc",
          "display_name": "John Smith",
          "email": "john_smith@acmecorp.com"
        }
      },
      "assets": [
        {
          ".tag": "file",
          "display_name": "reports.xls",
          "file_id": "id:jQKLsZFQImAAAAAAEZAAQt",
          "file_size": 4,
          "path": {
            "contextual": "/Contract Work/Draft",
            "namespace_relative": {
              "is_shared_namespace": false,
              "ns_id": "1234",
              "relative_path": "/Contract Work/Draft"
            }
          }
        }
      ],
      "context": {
        ".tag": "team_member",
        "account_id": "dbid:AAEIZtgeKLjx5uul1l65ZnNxXIfyNJ0-Ohc",
        "display_name": "John Smith",
        "email": "john_smith@acmecorp.com",
        "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224",
        "team": {
          "display_name": "A Team"
        },
        "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q"
      },
      "involve_non_team_member": true,
      "origin": {
        "access_method": {
          ".tag": "end_user",
          "end_user": {
            ".tag": "desktop",
            "session_id": "dbwsid:123456789012345678901234567890123456789"
          }
        },
        "geo_location": {
          "ip_address": "45.56.78.100",
          "city": "San Francisco",
          "country": "US",
          "region": "California"
        }
      },
      "participants": [
        {
          ".tag": "user",
          "user": {
            ".tag": "non_team_member",
            "account_id": "dbid:AAFQbdtgzUKxmEsRtkUIFbg7MSRGqJCeBnk",
            "display_name": "Jane Smith",
            "email": "jane_smith@acmecorp.com"
          }
        }
      ]
    }
  ],
  "has_more": false
}

Retrieves team events. If the result’s GetTeamEventsResult.has_more field is true, call get_events/continue with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll get_events/continue for new events.

Many attributes note ‘may be missing due to historical data gap’.

Note that the file_operations category and & analogous paper events are not available on all Dropbox Business plans /business/plans-comparison. Use features/get_values /developers/documentation/http/teams#team-features-get_values to check for this feature.

Permission : Team Auditing.

Required scope: events.read

Endpoint format: RPC

Authentication: Team

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Request

This endpoint expects a nullable object.

account_idstring or nullOptional=40 characters

Filter the events by account ID. Return only events with this account_id as either Actor, Context, or Participants.

categoryobject or nullOptional

Filter the returned events to a single category. Note that category shouldn’t be provided together with event_type.

Variant:

team_log_stone_gen.EventCategory.admin_alertingobjectRequired

Events that involve team related alerts.

event_typeobject or nullOptional

Filter the returned events to a single event type. Note that event_type shouldn’t be provided together with category.

Variant:

team_log_stone_gen.EventTypeArg.admin_alerting_alert_state_changedobjectRequired

(admin_alerting) Changed an alert state

limituintOptional1-1000Defaults to 1000

The maximal number of results to return per call. Note that some calls may not return limit number of events, and may even return no events, even with has_more set to true. In this case, callers should fetch again using get_events/continue.

timeobject or nullOptional

Filter by time range.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

cursorstring

Pass the cursor into get_events/continue to obtain additional events.

The value of cursor may change for each response from get_events/continue, regardless of the value of has_more; older cursor strings may expire.

Thus, callers should ensure that they update their cursor based on the latest value of cursor after each call, and poll regularly if they wish to poll for new events.

Callers should handle reset exceptions for expired cursors.

eventslist of objects

List of events. Note that events are not guaranteed to be sorted by their timestamp value.

has_moreboolean

Is true if there may be additional events that have not been returned yet. An additional call to get_events/continue can retrieve them. Note that has_more may be true, even if events is empty.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error