Method: activity.query

Query past activity in Google Drive.

HTTP request

POST https://driveactivity.googleapis.com/v2/activity:query

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "consolidationStrategy": {
    object (ConsolidationStrategy)
  },
  "pageSize": number,
  "pageToken": string,
  "filter": string,

  // Union field key can be only one of the following:
  "itemName": string,
  "ancestorName": string
  // End of list of possible types for union field key.
}
Fields
consolidationStrategy

object (ConsolidationStrategy)

Details on how to consolidate related actions that make up the activity. If not set, then related actions will not be consolidated.

pageSize

number

The requested number of activity to return. If not set, a default value will be used.

pageToken

string

The nextPageToken value returned from a previous activity.query request, if any.

filter

string

The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional "AND", where each expression is of the form "field operator value".

Supported fields:

  • time: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples:

    • time > 1452409200000 AND time <= 1492812924310
    • time >= "2016-01-10T01:02:03-05:00"
  • detail.action_detail_case: Uses the "has" operator (:) and either a singular value or a list of allowed action types enclosed in parentheses. Examples:

    • detail.action_detail_case: RENAME
    • detail.action_detail_case:(CREATE UPLOAD)
    • -detail.action_detail_case:MOVE

Union field key. The primary criteria in the query. The default is ancestor_name = "items/root" if no key is specified. key can be only one of the following:
itemName

string

Return activities for this Drive item. The format is "items/ITEM_ID".

ancestorName

string

Return activities for this Drive folder and all children and descendants. The format is "items/ITEM_ID".

Response body

If successful, the response body contains data with the following structure:

Response message for querying Drive activity.

JSON representation
{
  "activities": [
    {
      object (DriveActivity)
    }
  ],
  "nextPageToken": string
}
Fields
activities[]

object (DriveActivity)

List of activity requested.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/drive.activity
  • https://www.googleapis.com/auth/drive.activity.readonly

For more information, see the OAuth 2.0 Overview.

ConsolidationStrategy

How the individual activities are consolidated. A set of activities may be consolidated into one combined activity if they are related in some way, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related.

JSON representation
{

  // Union field strategy can be only one of the following:
  "none": {
    object (NoConsolidation)
  },
  "legacy": {
    object (Legacy)
  }
  // End of list of possible types for union field strategy.
}
Fields
Union field strategy. How the individual activities are consolidated. strategy can be only one of the following:
none

object (NoConsolidation)

The individual activities are not consolidated.

legacy

object (Legacy)

The individual activities are consolidated using the legacy strategy.

NoConsolidation

A strategy which does no consolidation of individual activities.

Legacy

A strategy which consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action.

Try it!

Send feedback about...

Google Drive Activity API
Need help? Visit our support page.