Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Custom Metric → List Custom Metrics

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Alpha) 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 specific 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 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 output is a JSON array where each item represents a custom metric object retrieved from the Google Analytics API. The structure corresponds directly to the API response for listing custom metrics under the specified property.

The json output field contains the parsed JSON response from the API call, typically including details such as:

  • Custom metric IDs
  • Names
  • Descriptions
  • Measurement units
  • Scope and other metadata related to each custom metric

No binary data is output by this node.

Dependencies

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

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials", ensure that a valid OAuth2 credential for Google Analytics is configured and selected.
  • Required Parameter Errors: Errors like "Property ID is required" indicate that the necessary input parameter was not provided. Make sure to specify the Property ID when using this operation.
  • API Call Failures: Errors returned from the Google Analytics API will be wrapped and shown with the message prefix "Error calling Google Analytics API". Check the error message for details such as permission issues, invalid IDs, or quota limits.
  • Pagination Handling: If many custom metrics exist, consider using the Page Size and Page Token query parameters to paginate through results.

Links and References

This summary focuses on the "Admin (V1Alpha) - Custom Metric" resource and the "List Custom Metrics" operation as requested.

Discussion