Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Beta) - Custom Metric → Get Custom Metric

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Beta) resource for Custom Metrics. The "Get Custom Metric" operation allows users to retrieve detailed information about a specific custom metric within a Google Analytics property.

Common scenarios where this node is beneficial include:

  • Fetching metadata and configuration details of a custom metric to understand how it is defined.
  • Auditing or verifying custom metrics setup in Google Analytics properties.
  • Integrating custom metric data retrieval into automated workflows for reporting or monitoring purposes.

For example, a marketing analyst might use this node to programmatically fetch the definition of a custom metric used in their GA4 property to ensure consistency across reports.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property that contains the custom metric.
Custom Metric ID The unique identifier of the custom metric to retrieve details for.
Query Parameters Optional additional parameters to refine the request, including:
- Calculated Metric ID: ID for a calculated metric to use.
- Entity: Level of data access report (property or account).
- Filter: Expression to filter results.
- Names: Names of access bindings to retrieve.
- Page Size: Maximum number of report tasks to return (number).
- Page Token: Token for fetching next page of results (string).
- Show Deleted: Whether to include soft-deleted properties (boolean).
- Universal Analytics Property ID: UA property to look up connected GA4 property.
- Update Mask: List of fields to update (snake case field names).

Output

The output is a JSON array containing the response from the Google Analytics API for the requested custom metric. This includes all available details about the custom metric such as its name, scope, measurement unit, and other configuration attributes.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "name": "properties/1234/customMetrics/5678",
    "parameterName": "customMetric1",
    "displayName": "Custom Metric 1",
    "description": "Description of the custom metric",
    "measurementUnit": "standard",
    "scope": "event",
    "restrictedMetricType": "none",
    "type": "integer"
  }
]

Dependencies

  • Requires an OAuth2 credential configured for Google Analytics API access.
  • The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1beta.
  • Proper permissions on the Google Analytics property are necessary to retrieve custom metric details.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials", ensure that the OAuth2 credentials for Google Analytics API are properly set up and selected.
  • Required Parameter Errors: Errors like "Property ID is required" or "Custom Metric ID is required" indicate missing mandatory inputs. Verify that these IDs are correctly provided.
  • 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 description for details such as permission issues or invalid IDs.
  • Pagination Issues: If using query parameters like pageToken or pageSize, ensure values are valid to avoid unexpected empty responses.

Links and References

Discussion