Gws Admin Reports
Query Google Workspace admin audit activities and customer or entity usage reports from the terminal when you need compliance trails or seat and app usage stats.
Overview
gws-admin-reports is an agent skill most often used in Operate (also Grow) that documents Google Workspace Admin SDK audit logs and usage report calls through the `gws` CLI.
Install
npx skills add https://github.com/googleworkspace/cli --skill gws-admin-reportsWhat is this skill?
- Wraps Admin SDK reports_v1 via `gws admin-reports` with list and watch on activities plus get on customer and entity usa
- Documents channels.stop for tearing down report notification channels
- Depends on gws-shared for auth, global flags, and security rules
- Requires the `gws` binary on PATH (openclaw metadata v0.22.5)
- CLI help entry point: `gws admin-reports --help`
- Four API resource families documented: activities, channels, customerUsageReports, entityUsageReports
- Openclaw metadata version 0.22.5
Adoption & trust: 15.7k installs on skills.sh; 26.9k GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
You need Workspace admin activity or usage report data but do not want to hand-roll Admin SDK clients and auth for every agent run.
Who is it for?
Indie operators on Google Workspace who already use `gws` and want scripted audit or usage report access from Claude Code, Cursor, or Codex.
Skip if: Teams without Workspace admin privileges, without the `gws` binary configured, or who need a full BI product instead of API-backed report retrieval.
When should I use this skill?
You need Google Workspace audit logs or usage reports and already use the `gws` CLI with gws-shared auth patterns.
What do I get? / Deliverables
Your agent runs documented `gws admin-reports` commands to list activities, fetch usage reports, or manage report channels with shared auth patterns from gws-shared.
- CLI command sequences for activities list/watch and usage report get operations
- Channel stop commands for report notification cleanup
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Canonical shelf is Operate because audit logs and admin reports are production visibility and governance work, not feature build. Monitoring is the best fit for ongoing activity streams, usage report pulls, and optional push watches on admin report channels.
Where it fits
List recent Admin console activities after a suspicious settings change.
Fetch a customer usage report snapshot to see which Workspace apps saw adoption last month.
Stop an obsolete admin-reports push channel after migrating notification endpoints.
How it compares
Use instead of ad-hoc Google Admin console clicking when you need repeatable CLI-driven audit and usage report pulls.
Common Questions / FAQ
Who is gws-admin-reports for?
Solo builders and small teams who administer Google Workspace and want their coding agent to invoke Admin Reports APIs via the `gws` CLI.
When should I use gws-admin-reports?
During Operate when investigating admin or Drive activity logs or monitoring channels, and during Grow when pulling customer or entity usage report properties for internal analytics.
Is gws-admin-reports safe to install?
It documents API calls that use your Workspace credentials; review the Security Audits panel on this page and follow gws-shared security rules before granting agent access.
SKILL.md
READMESKILL.md - Gws Admin Reports
# admin-reports (reports_v1) > **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it. ```bash 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: ```bash # 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.