Skip to main content
Google Workspace Admin logo

Overview

Add Google Workspace Admin to any ModuleX agent or workflow. Retrieve admin audit activity reports from Google Workspace via the Admin SDK Reports API (admin.googleapis.com).
Categories: Productivity & Collaboration · Admin · Enterprise · Auth: OAuth2 · Actions: 4

Authentication

OAuth2 Authentication

Connect using Google OAuth (recommended)

Required Credentials

FieldDescriptionRequiredFormat
Client IDGoogle OAuth App Client IDYesxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com
Client SecretGoogle OAuth App Client SecretYesGOCSPX-xxxxxxxxxxxxxxxxxxxxxxxxxxxx

OAuth Configuration

  • Authorization URL: https://accounts.google.com/o/oauth2/v2/auth
  • Token URL: https://oauth2.googleapis.com/token
  • Scopes: https://www.googleapis.com/auth/admin.reports.audit.readonly

Available Actions

Parameters

application_name
string
required
Application name to retrieve events for. Valid values: access_transparency, admin, calendar, chat, drive, gcp, gplus, groups, groups_enterprise, jamboard, login, meet, mobile, rules, saml, token, user_accounts, context_aware_access, chrome, data_studio, keep
user_key
string
required
Profile ID or email of the administrator to filter activities for
event_name
string
Name of the event to filter by
end_time
string
End of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
start_time
string
Beginning of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
max_results
integer
Maximum number of activity records to return per page (default 1000)
filters
string
Comma-separated event parameter filters (e.g. parameter_name relational_operator value)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "activities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Activities",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListActivitiesByAdminOutput",
  "type": "object"
}

Parameters

application_name
string
required
Application name to retrieve events for. Valid values: access_transparency, admin, calendar, chat, drive, gcp, gplus, groups, groups_enterprise, jamboard, login, meet, mobile, rules, saml, token, user_accounts, context_aware_access, chrome, data_studio, keep
event_name
string
required
Name of the event to filter by
user_key
string
required
Profile ID or email of the administrator to filter activities for
end_time
string
End of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
start_time
string
Beginning of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
max_results
integer
Maximum number of activity records to return per page (default 1000)
filters
string
Comma-separated event parameter filters (e.g. parameter_name relational_operator value)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "activities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Activities",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListActivitiesByEventAndAdminOutput",
  "type": "object"
}

Parameters

application_name
string
required
Application name to retrieve events for. Valid values: access_transparency, admin, calendar, chat, drive, gcp, gplus, groups, groups_enterprise, jamboard, login, meet, mobile, rules, saml, token, user_accounts, context_aware_access, chrome, data_studio, keep
event_name
string
required
Name of the event to filter by
end_time
string
End of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
start_time
string
Beginning of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
max_results
integer
Maximum number of activity records to return per page (default 1000)
filters
string
Comma-separated event parameter filters (e.g. parameter_name relational_operator value)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "activities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Activities",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListActivitiesByEventNameOutput",
  "type": "object"
}

Parameters

application_name
string
required
Application name to retrieve events for. Valid values: access_transparency, admin, calendar, chat, drive, gcp, gplus, groups, groups_enterprise, jamboard, login, meet, mobile, rules, saml, token, user_accounts, context_aware_access, chrome, data_studio, keep
end_time
string
End of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
start_time
string
Beginning of the time range in RFC 3339 format (e.g. 2010-10-28T10:26:35.000Z)
max_results
integer
Maximum number of activity records to return per page (default 1000)
filters
string
Comma-separated event parameter filters (e.g. parameter_name relational_operator value)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "activities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Activities",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListAllActivitiesOutput",
  "type": "object"
}

Limits & Quotas

  • Admin SDK Reports API quota: 2,400 queries per minute per Google Workspace domain (default).
  • Per-user limit: 480 queries per minute per user.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Cal.com

Canva

ConvertAPI