Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Key Event → List Key Events

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Alpha) resource for managing Key Events within a property. The "List Key Events" operation retrieves a list of key events configured in a specified Google Analytics property. This is useful for analytics administrators or marketers who want to programmatically access and review important user interaction events tracked in their Google Analytics properties.

Practical scenarios include:

  • Automating the retrieval of key event configurations for auditing or reporting.
  • Integrating key event data into custom dashboards or workflows.
  • Synchronizing key event definitions across multiple properties or accounts.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property from which to list key events.
Query Parameters Optional parameters to filter or paginate the results. Includes:
- Calculated Metric ID: Filter by calculated metric ID.
- Entity: Specify data access report level (property or account).
- Filter: Expression to filter results.
- Names: Names of access bindings to retrieve.
- Page Size: Maximum number of results to return (default 10).
- Page Token: Token for fetching next page of results.
- Show Deleted: Whether to include soft-deleted ("trashed") properties (default true).
- Universal Analytics Property ID: UA property to look up connected GA4 property.
- Update Mask: List of fields to update (snake case).

Output

The node outputs a JSON array where each item represents a key event object retrieved from the Google Analytics property. The structure corresponds to the Google Analytics API response for key events, typically including details such as event name, parameters, and configuration metadata.

No binary data output is involved.

Dependencies

  • Requires an OAuth2 credential for Google Analytics API authentication.
  • The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1alpha.
  • Proper permissions on the Google Analytics property are necessary to list key events.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that a valid OAuth2 credential for Google Analytics is configured in n8n.
  • Required Parameter Errors: Errors like "Property ID is required" indicate that the Property ID input was not provided; make sure to specify it.
  • API Request Failures: Errors returned from the Google Analytics API will be wrapped with "Error calling Google Analytics API" and include the original message. Check the API quota, permissions, and correctness of parameters.
  • Pagination Issues: When retrieving large lists, use the "Page Token" query parameter to fetch subsequent pages.

Links and References

Discussion