gws-admin-reports
googleworkspace/cli
Query Google Workspace audit logs and usage reports via Admin SDK.
What is gws-admin-reports?
Access Google Workspace Admin SDK to retrieve audit logs, activity reports, and usage statistics for your organization. Use this to monitor account activities, track resource consumption, and generate compliance reports.
- Retrieve activity logs for specific applications and customers
- Monitor account activities with push notifications via watch channels
- Get customer-wide usage reports and statistics
- Access entity usage reports for resources used within your account
- Generate user usage reports for sets of users
How to install gws-admin-reports
npx skills add null --skill gws-admin-reports- gws CLI tool installed
- Google Workspace Admin SDK credentials configured (see gws-shared/SKILL.md)
- Appropriate admin permissions in Google Workspace
How to use gws-admin-reports
- 1.Run `gws admin-reports --help` to browse available resources and methods
- 2.Use `gws schema admin-reports.<resource>.<method>` to inspect required parameters and types
- 3.Build your command with `gws admin-reports <resource> <method>` plus `--params` or `--json` flags
- 4.Execute the command to retrieve logs or reports
Use cases
- Audit admin console and Google Drive activities for compliance
- Track resource consumption across your organization
- Monitor user activity patterns and usage trends
- Set up real-time notifications for account activities
- Generate usage reports for billing or capacity planning
- Google Workspace administrators
- Compliance and audit teams
- IT operations and monitoring teams
- Organization managers tracking resource usage
gws-admin-reports FAQ
See the gws-shared/SKILL.md file for auth setup and security rules. You need Google Workspace Admin SDK credentials configured.
Run `gws schema admin-reports.<resource>.<method>` to see required params, types, and defaults for any API method.
Yes, use the `activities watch` method to start receiving push notifications for account activities.
You can retrieve customer usage reports, entity usage reports, and user usage reports with various parameters for filtering and analysis.
Full instructions (SKILL.md)
Source of truth, from googleworkspace/cli.
name: gws-admin-reports description: "Google Workspace Admin SDK: Audit logs and usage reports." metadata: version: 0.22.5 openclaw: category: "productivity" requires: bins: - gws cliHelp: "gws admin-reports --help"
admin-reports (reports_v1)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws admin-reports <resource> <method> [flags]
API Resources
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.watch— Start receiving notifications for account activities. For more information, see Receiving Push Notifications.
channels
stop— Stop watching resources through this channel.
customerUsageReports
get— Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.
entityUsageReports
get— Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.
userUsageReport
get— Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws admin-reports --help
# Inspect a method's required params, types, and defaults
gws schema admin-reports.<resource>.<method>
Use gws schema output to build your --params and --json flags.
Related skills
More from googleworkspace/cli and the wider catalog.
gws-gmail
Send, read, and manage Gmail emails via Google Workspace CLI.
gws-drive
Manage Google Drive files, folders, and shared drives via CLI.
gws-docs
Read and write Google Docs via command line.
gws-calendar
Manage Google Calendar events, calendars, and access control via CLI.
gws-sheets
Read and write Google Sheets spreadsheets via CLI.
gws-gmail-send
Send emails via Gmail with attachments, CC/BCC, HTML support, and draft options.