List Activities
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.
External Documentation
To learn more, visit the Google Workspace documentation.
Basic Parameters
Parameter | Description |
---|---|
Application Name | Application name for which the events are to be retrieved. For more information about the Application Name, see the activity parameters reference guide. |
End Time | 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. |
Event Name | The name of the event being queried by the API. Each eventName is related to a specific Google Workspace service or feature which the API organizes into types of events. For more information about eventName query strings and parameters, see the ApplicationName documentation. |
Filters | The filters query string is a comma-separated list composed of event parameters 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 request's parameter doesn't belong to the eventName. For more information about the available eventName fields for each application and their associated parameters, go to the ApplicationName table, then click through to the Activity Events page in the Appendix for the application you want. |
Start Time | 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. |
Advanced Parameters
Parameter | Description |
---|---|
Delegated User Override | Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input. |
Max Results | 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. |
Example Output
{
"kind": "admin#reports#activities",
"etag": "\"HT17nNOKg3qK25zh6p3L6mirrcELRXThl-03egjpiRg/bQC1fjTKt9X1xizuS--qchBBszd\"",
"items": [
{
"kind": "admin#reports#activity",
"id": {
"time": "2023-07-05T05:32:34.210Z",
"uniqueQualifier": "-8094899614681261977",
"applicationName": "admin",
"customerId": "C00t3zpd2"
},
"etag": "\"HT17nNOKg3qK25zh6p3L6mirrcELRXThl-03egjpiRg/7neN4KVdiWsCt5d7O2Xr4_ZVb0y\"",
"actor": {
"callerType": "USER",
"email": "blink@test.com",
"profileId": "111333624104757398244"
},
"events": [
{
"type": "DOMAIN_SETTINGS",
"name": "REMOVE_APPLICATION",
"parameters": [
{
"name": "APP_ID",
"value": "37363080244"
},
{
"name": "APPLICATION_NAME",
"value": "Blink Test"
}
]
}
]
}
]
}
Workflow Library Example
List Activities with Google Workspace and Send Results Via Email