View as Markdown
Google Workspace Admin icon

Google Workspace Admin ACTION

List Activities By Event Name and Admin

Retrieves a report of all activities for a specific event name and admin. See the docs for more information
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Workspace Admin account once, then configure and run List Activities By Event Name and Admin from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_workspace-list-activities-by-event-and-admin",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_workspace: { authProvisionId: "apn_xxxxxxx" },
    applicationName: "Application Name",
    eventName: "Event Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Activities By Event Name and Admin inputs
Property Type Description
applicationName Application Name string
Application name for which the events are to be retrieved.
Required
eventName Event Name string
The name of the event being queried by the API. Each Event Name is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar Event Name activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and Event Name parameters. For more information about Event Name query strings and parameters, see the list of event names for various applications above in Application Name. For more details on this parameter see the docs here
Required
userKey User Key string
Represents the profile ID or the user email for which the data should be filtered. Unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For more details on this parameter see the docs here
Required Dynamic
endTime End Time string
Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. For more details on this parameter see the docs here
Optional
startTime Start Time string
Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from Start Time until End Time. The Start Time must be before the End Time (if specified) and the current time when the request is made, or the API returns an error. For more details on this parameter see the docs here
Optional
maxResults Max Results integer
Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The Max Results query string is optional in the request. The default value is 1000. For more details on this parameter see the docs here
Optional
filters Filters string
The filters query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},..... For more details on this parameter see the docs here
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_workspace-list-activities-by-event-and-admin
Version
0.0.2
App
Google Workspace Admin
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes