- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- ApplicationName
Start receiving notifications for account activities. For more information, see Receiving Push Notifications.
HTTP request
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
userKey or all |
Represents the profile ID or the user email for which the data should be filtered. Can be |
applicationName |
Application name for which the events are to be retrieved. |
Query parameters
Parameters | |
---|---|
actorIpAddress |
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 |
The unique ID of the customer to retrieve data for. |
endTime |
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:
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 |
The name of the event being queried by the API. Each |
filters |
The These event parameters are associated with a specific In the following Drive activity examples, the returned list consists of all
A
Note: The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned. |
maxResults |
Determines how many activity records are shown on each response page. For example, if the request sets |
orgUnitID |
ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. |
pageToken |
The token to specify next page. A report with multiple pages has a |
startTime |
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 |
groupIdFilter |
Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" |
Request body
The request body contains an instance of SubscriptionChannel
.
Response body
A notification channel used to watch for resource changes.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
Fields | |
---|---|
id |
A UUID or similar unique string that identifies this channel. |
token |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |
expiration |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |
type |
The type of delivery mechanism used for this channel. The value should be set to |
address |
The address where notifications are delivered for this channel. |
payload |
A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional. |
params |
Additional parameters controlling delivery channel behavior. Optional. An object containing a list of |
resourceId |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |
resourceUri |
A version-specific identifier for the watched resource. |
kind |
Identifies this as a notification channel used to watch for changes to a resource, which is " |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admin.reports.audit.readonly
For more information, see the Authorization guide.
ApplicationName
Application name for which the events are to be retrieved.
Enums | |
---|---|
access_transparency |
The Google Workspace 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 Google Calendar application's activity reports return information about various Calendar activity events. |
chat |
The Chat activity reports return information about various Chat 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 Google Workspace Business and Google Workspace Enterprise customers. |
gcp |
The Google Cloud Platform application's activity reports return information about various GCP activity events. |
gplus |
The Google+ application's activity reports return information about various Google+ activity events. |
groups |
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. |
jamboard |
The Jamboard activity reports return information about various Jamboard activity events. |
login |
The Login application's activity reports return account information about different types of Login activity events. |
meet |
The Meet Audit activity report returns information about different types of Meet Audit activity events. |
mobile |
The Device Audit activity report returns information about different types of Device Audit activity events. |
rules |
The Rules activity report returns information about different types of Rules activity events. |
saml |
The SAML activity report returns information about different types of SAML activity events. |
token |
The Token application's activity reports return account information about different types of Token activity events. |
user_accounts |
The User Accounts application's activity reports return account information about different types of User Accounts activity events. |
context_aware_access |
The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules. |
chrome |
The Chrome activity reports return information about Chrome browser and Chrome OS events. |
data_studio |
The Data Studio activity reports return information about various types of Data Studio activity events. |
keep |
The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers. |