Activities: list

Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.
Try it now.

Request

HTTP request

GET https://www.googleapis.com/admin/reports/v1/activity/users/userKey or all/applications/applicationName

Parameters

Parameter name Value Description
Path parameters
applicationName string Application name for which the events are to be retrieved.

Acceptable values are:
  • "access_transparency": The G Suite Access Transparency activity reports return information about different types of Access Transparency activity events.
  • "admin": The Admin console application's activity reports return account information about different types of administrator activity events.
  • "calendar": The G Suite Calendar application's activity reports return information about various Calendar activity events.
  • "drive": The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for G Suite Business customers.
  • "gplus": The Google+ application's activity reports return information about various Google+ activity events.
  • "group": The Google Groups application's activity reports return information about various Groups activity events.
  • "groups_enterprise": The Enterprise Groups activity reports return information about various Enterprise group activity events.
  • "login": The G Suite Login application's activity reports return account information about different types of Login activity events.
  • "mobile": The G Suite Mobile Audit activity report return information about different types of Mobile Audit activity events.
  • "rules": The G Suite Rules activity report return information about different types of Rules activity events.
  • "token": The G Suite Token application's activity reports return account information about different types of Token activity events.
  • "user_accounts": The G Suite User Accounts application's activity reports return account information about different types of User Accounts activity events.
userKey or all string Represents the profile ID or the user email for which the data should be filtered.

Acceptable values are:
  • "all": Returns activity events for all users.
  • "userKey": Represents the user's unique G Suite profile ID or the primary email address.
Optional query parameters
actorIpAddress string The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
customerId string The unique ID of the customer to retrieve data for.
endTime string Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts:
  • Date of the API's request for a report: When the API created and retrieved the report.
  • Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.
  • Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August.
If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.
eventName string The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.
filters string The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],...
These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.

In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E):
GET...&eventName=CHANGE_CALENDAR_SETTING
      &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS

In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):
GET...&eventName=edit&filters=doc_id
GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765

The relational operators include:

  • == - 'equal to'.
  • <> - 'not equal to'. It is URL-encoded (%3C%3E).
  • < - 'less than'. It is URL-encoded (%3C).
  • <= - 'less than or equal to'. It is URL-encoded (%3C=).
  • > - 'greater than'. It is URL-encoded (%3E).
  • >= - 'greater than or equal to'. It is URL-encoded (%3E=).

maxResults integer Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000. Acceptable values are 1 to 1000, inclusive. (Default: 1000)
orgUnitID string ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit.
pageToken string The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.
startTime string Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/admin.reports.audit.readonly

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "admin#reports#activities",
  
  "nextPageToken": string,
  "items": [
    {
      "kind": "admin#reports#activity",
      "id": {
        "time": datetime,
        "uniqueQualifier": long,
        "applicationName": string,
        "customerId": string
      },
      
      "actor": {
        "callerType": string,
        "email": string,
        "profileId": long,
        "key": string
      },
      "ownerDomain": string,
      "ipAddress": string,
      "events": [
        {
          "type": string,
          "name": string,
          "parameters": [
            {
              "name": string,
              "value": string,
              "intValue": long,
              "boolValue": boolean,
              "multiValue": [
                string
              ],
              "multiIntValue": [
                long
              ],
              "messageValue": {
                "parameter": [
                  {
                    "name": string,
                    "value": string,
                    "multiValue": [
                      string
                    ],
                    "intValue": long,
                    "multiIntValue": [
                      long
                    ],
                    "boolValue": boolean,
                    "multiBoolValue": [
                      boolean
                    ]
                  }
                ]
              },
              "multiMessageValue": [
                {
                  "parameter": [
                    {
                      "name": string,
                      "value": string,
                      "multiValue": [
                        string
                      ],
                      "intValue": long,
                      "multiIntValue": [
                        long
                      ],
                      "boolValue": boolean,
                      "multiBoolValue": [
                        boolean
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
Property name Value Description Notes
kind string The type of API resource. For an activity report, the value is reports#activities.
nextPageToken string Token for retrieving the follow-on next page of the report. The nextPageToken value is used in the request's pageToken query string.
items[] list Each activity record in the response.
items[].kind string The type of API resource. For an activity report, the value is audit#activity.
items[].id object Unique identifier for each activity record.
items[].id.time datetime Time of occurrence of the activity. This is in UNIX epoch time in seconds.
items[].id.uniqueQualifier long Unique qualifier if multiple events have the same time.
items[].id.applicationName string Application name to which the event belongs. For possible values see the list of applications above in applicationName.
items[].id.customerId string The unique identifier for a G suite account.
items[].actor object User doing the action.
items[].actor.callerType string The type of actor.

Acceptable values are:
  • "EXTERNAL_USER": A user outside the domain
  • "KEY": A non-human actor, such as a OAuth 2LO entity request or robot account
  • "USER": Another user in the same domain (default)
items[].actor.email string The primary email address of the actor. May be absent if there is no email address associated with the actor.
items[].actor.profileId long The unique G Suite profile ID of the actor. May be absent if the actor is not a G Suite user.
items[].actor.key string Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.
items[].ownerDomain string This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.
items[].ipAddress string IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into G Suite which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
items[].events[] list Activity events in the report.
items[].events[].type string Type of event. The G Suite service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.
items[].events[].name string Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific G Suite service or feature which the API organizes into types of events.
For eventName request parameters in general:
  • If no eventName is given, the report returns all possible instances of an eventName.
  • When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested.

For more information about eventName properties, see the list of event names for various applications above in applicationName.
items[].events[].parameters[] list Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName.
items[].events[].parameters[].name string The name of the parameter.
items[].events[].parameters[].value string String value of the parameter.
items[].events[].parameters[].intValue long Integer value of the parameter.
items[].events[].parameters[].boolValue boolean Boolean value of the parameter.
items[].events[].parameters[].multiValue[] list String values of the parameter.
items[].events[].parameters[].multiIntValue[] list Integer values of the parameter.
items[].events[].parameters[].messageValue object Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]
items[].events[].parameters[].messageValue.parameter[] list Parameter values
items[].events[].parameters[].messageValue.parameter[].name string The name of the parameter.
items[].events[].parameters[].messageValue.parameter[].value string String value of the parameter.
items[].events[].parameters[].messageValue.parameter[].multiValue[] list Multiple string values of the parameter.
items[].events[].parameters[].messageValue.parameter[].intValue long Integer value of the parameter.
items[].events[].parameters[].messageValue.parameter[].multiIntValue[] list Multiple integer values of the parameter.
items[].events[].parameters[].messageValue.parameter[].boolValue boolean Boolean value of the parameter.
items[].events[].parameters[].messageValue.parameter[].multiBoolValue[] list Multiple boolean values of the parameter.
items[].events[].parameters[].multiMessageValue[] list List of messageValue objects.
items[].events[].parameters[].multiMessageValue[].parameter[] list Parameter values
items[].events[].parameters[].multiMessageValue[].parameter[].name string The name of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].value string String value of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].multiValue[] list Multiple string values of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].intValue long Integer value of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].multiIntValue[] list Multiple integer values of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].boolValue boolean Boolean value of the parameter.
items[].events[].parameters[].multiMessageValue[].parameter[].multiBoolValue[] list Multiple boolean values of the parameter.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.