gws-admin-reports

Retrieves Google Workspace audit logs and usage reports via the Admin SDK Reports API.

Updated Nov 9, 2023
One-click install
npx skills add https://github.com/oresttokovenko/dot-files --skill gws-admin-reports-oresttokovenko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gws-admin-reports
Source: https://github.com/oresttokovenko/dot-files/tree/main/chezmoi/dot_agents/skills/gws-admin-reports
Command: npx skills add https://github.com/oresttokovenko/dot-files --skill gws-admin-reports-oresttokovenko

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Google Workspace administrators need visibility into account activity and resource usage, but manually navigating the Admin console for audit logs and usage statistics is slow and hard to automate. This Skill exposes the Admin SDK Reports API through the gws CLI so activity and usage data can be queried programmatically. ## Core Features & Use Cases - Activity Auditing: List and watch account activities for applications like the Admin console and Google Drive, including push notification channels. - Usage Reporting: Retrieve customer-level, entity-level, and user-level usage reports with statistics and properties. - Schema Discovery: Inspect any method's required parameters, types, and defaults with gws schema before building requests. - Use Case: An administrator investigating suspicious logins can list Admin console activities filtered by user and date range, then pull a user usage report to correlate account behavior. ## Quick Start Ask the AI to list recent Admin console activity events for your Google Workspace customer account using the gws admin-reports activities list method.

Frequently Asked Questions about gws-admin-reports

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I list Google Workspace admin activity logs from the command line?

Use gws admin-reports activities list with the appropriate customer and application parameters. Run gws schema admin-reports.activities.list first to see required parameters, types, and defaults before building your request.

How to get Google Workspace user usage reports programmatically?

Call gws admin-reports userUsageReport get to retrieve statistics for a set of users in the account. Customer-level and entity-level reports are available through customerUsageReports get and entityUsageReports get.

Can I receive push notifications for Google Workspace activity events?

Yes, the activities watch method starts receiving push notifications for account activities. Use the channels stop method to terminate a notification channel when monitoring is no longer needed.

What do I need before using the gws admin-reports commands?

You need the gws binary installed and authentication configured as described in the gws-shared skill. If that shared skill is missing, run gws generate-skills to create it before calling any Reports API method.

Why does my gws admin-reports API call fail with parameter errors?

Failures usually come from missing or mistyped parameters. Inspect the method with gws schema admin-reports.<resource>.<method> to confirm required params, types, and defaults, then build your --params and --json flags accordingly.