Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Beta) - Key Event → List Key Events

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Beta) resource for Key Events. The "List Key Events" operation allows users to retrieve a list of key events configured within a specified Google Analytics property. This is useful for analytics administrators or marketers who want to programmatically access and manage key event data related to their properties.

Common scenarios include:

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

Example: A marketing team wants to fetch all key events from a specific property to analyze which events are tracked and ensure consistency in event naming conventions.

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 list request. 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: Lookup connected GA4 property.
- Update Mask: List of fields to update (snake case).

Output

The node outputs a JSON array containing the list of key events retrieved from the specified property. Each item in the array represents a key event object as returned by the Google Analytics Admin API. The structure typically includes details such as event name, event parameters, and other metadata relevant to the key event configuration.

No binary data output is involved.

Dependencies

  • Requires an OAuth2 API credential for Google Analytics with appropriate permissions to access the Admin API.
  • The node uses the Google Analytics Admin API endpoints, specifically the v1beta version for key events.
  • Network connectivity to https://analyticsadmin.googleapis.com/ is required.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid Google Analytics OAuth2 credential is configured and selected.
  • Required Parameter Errors: The node validates required parameters like Property ID. Missing these will cause errors; provide all necessary IDs.
  • API Request Failures: Errors from the Google Analytics API (e.g., permission denied, invalid IDs) will be surfaced with messages prefixed by "Error calling Google Analytics API". Check API permissions and parameter correctness.
  • Pagination Handling: When retrieving large lists, use the Page Token query parameter to paginate through results.

Links and References

This summary focuses on the "Admin (V1Beta) - Key Event" resource and the "List Key Events" operation as requested.

Discussion