Skip to main content
skill Claude Code CX Codex Cursor GitHub Copilot official · Google

gws-admin-reports — Claude skill: Google Workspace audit logs

A skill that gives your agent the Admin SDK Reports API: audit logs and usage reports for a Google Workspace account.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add googleworkspace/cli --skill gws-admin-reports -a claude-code
Open on GitHub

What gws-admin-reports does

The skill wraps reports_v1 of the Admin SDK behind gws admin-reports . Your agent can pull the activity list for a customer account and application — Admin console, Google Drive — plus usage reports for the customer, for entities, and for individual users.

Five resources are covered: activities with list and watch, channels.stop to end notifications, and the three get methods on customerUsageReports, entityUsageReports and userUsageReport. Before calling anything, the agent inspects gws schema admin-reports.. and builds --params and --json from that output.

You need the gws binary and ../gws-shared/SKILL.md for auth and global flags. Missing it? Run gws generate-skills. Worth installing if you dig through Workspace admin logs often; for a one-off export the web console is faster.

What it helps with

  • pull the audit log for Admin console actions
  • fetch a usage report for a Google Workspace account
  • check activity stats for one user
  • subscribe to notifications about new account activities
  • stop a notification channel you no longer need

Example prompts for the agent

  • list activities for Google Drive over the past week
  • get the user usage report for this account
  • what params does gws admin-reports userUsageReport get need?

How to install gws-admin-reports

1Skills CLI (Vercel)

npx skills add googleworkspace/cli --skill gws-admin-reports -a claude-code

2Manually: put the files in place

~/.claude/skills/gws-admin-reports/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/gws-admin-reports/

From the same set95

The whole set →
gws-gmail official googleworkspace This skill hands your agent Gmail: send mail, read the inbox, reply in a thread. Useful when email work already runs through the gws CLI. Claude Code CX Codex Cursor +1 81,900installs gws-gmail-send official googleworkspace A skill that teaches your agent to send Gmail from the terminal: recipients, subject, body, attachments and drafts. Claude Code CX Codex Cursor +1 74,700installs gws-drive official googleworkspace This skill hands your agent Google Drive through the gws CLI: files, folders, shared drives, comments and access requests. Useful when docs move through code. Claude Code CX Codex Cursor +1 74,500installs gws-shared official googleworkspace This skill gives agents shared rules for gws CLI authentication, flags, and output formats. Use it when working with gws commands. Claude Code CX Codex Cursor +1 66,000installs gws-calendar official googleworkspace Manage Google Calendar events, access rules, and schedules through the gws CLI tool. Claude Code CX Codex Cursor +1 61,100installs gws-sheets official googleworkspace This skill lets an agent read and edit Google Sheets through the CLI. Use it when a coding workflow needs spreadsheet data or table updates. Claude Code CX Codex Cursor +1 58,800installs gws-docs official googleworkspace This skill lets an agent read and update Google Docs through gws. Use it when document changes should happen from an agent chat. Claude Code CX Codex Cursor +1 58,300installs gws-sheets-read official googleworkspace Reads cell values and sheets from Google Spreadsheets via CLI. Useful when an agent needs spreadsheet data without risk of altering it. Claude Code CX Codex Cursor +1 50,600installs

Similar

Questions about gws-admin-reports

How do I install gws-admin-reports in Claude?

Run npx skills add googleworkspace/cli --skill gws-admin-reports -a claude-code. The skill lands in ~/.claude/skills/gws-admin-reports/SKILL.md.

What does gws-admin-reports do?

It hands your agent commands for the Admin SDK Reports API: activity audit logs and usage reports for a Google Workspace account, its entities and its users.

What do I need before using it?

The gws binary and ../gws-shared/SKILL.md with auth settings. If that file is missing, create it with gws generate-skills.

Source text

SKILL.md · Apache-2.0
---
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.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.

© googleworkspace · Apache-2.0 · googleworkspace/cli

See also

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor