Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Beta) - Custom Metric → List Custom Metrics

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Beta) resource for Custom Metrics. The "List Custom Metrics" operation allows users to retrieve a list of custom metrics defined within a specified Google Analytics property. This is useful for analytics administrators or marketers who want to programmatically access and manage their custom metrics data.

Common scenarios include:

  • Automating the retrieval of all custom metrics for reporting or auditing purposes.
  • Integrating custom metric data into other workflows or dashboards.
  • Synchronizing custom metrics metadata between Google Analytics and other systems.

Example: A user wants to fetch all custom metrics for a particular property to analyze which metrics are currently active and available for use in reports.

Properties

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

Output

The node outputs a JSON array where each element represents a custom metric object retrieved from the Google Analytics API. The structure corresponds to the API's response for listing custom metrics, typically including fields such as metric name, ID, description, measurement unit, and scope.

No binary data output is produced by this node.

Dependencies

  • Requires an OAuth2 credential configured for Google Analytics API access.
  • The node uses the Google Analytics Admin API endpoints (https://analyticsadmin.googleapis.com/v1beta).
  • Proper permissions on the Google Analytics property are necessary to list custom metrics.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that the OAuth2 credentials are properly set up and linked in n8n.
  • Required Parameter Errors: Errors like "Property ID is required" indicate that the mandatory propertyId parameter was not provided. Make sure to specify the correct property ID.
  • API Request Failures: Errors returned from the Google Analytics API will be wrapped and shown with the message "Error calling Google Analytics API." Check the error details for issues such as insufficient permissions, invalid IDs, or quota limits.
  • Pagination Handling: If many custom metrics exist, use the Page Token and Page Size query parameters to paginate through results.

Links and References

This summary is based solely on static analysis of the provided source code and input property definitions.

Discussion