Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Custom Dimension → List Custom Dimensions

AI-generated

Overview

This node integrates with the Google Analytics API, specifically targeting the Admin (V1Alpha) resource for managing Custom Dimensions within a property. The "List Custom Dimensions" operation retrieves a list of custom dimensions configured in a specified Google Analytics property.

Use cases include:

  • Fetching all custom dimensions to audit or analyze how data is being tracked.
  • Integrating custom dimension metadata into workflows for reporting or further processing.
  • Automating monitoring or synchronization tasks involving custom dimensions.

For example, a marketing analyst might use this node to automatically retrieve and log all custom dimensions from a property to ensure tracking consistency across campaigns.

Properties

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

Output

The node outputs an array of JSON objects representing the custom dimensions retrieved from the specified property. Each object corresponds to a custom dimension resource as returned by the Google Analytics Admin API.

The output JSON structure includes all standard fields of a custom dimension entity, such as its ID, name, scope, description, and other metadata defined by the API.

No binary data output is involved.

Dependencies

  • Requires valid Google Analytics API OAuth2 credentials configured in n8n.
  • The node uses the Google Analytics Admin API v1alpha endpoint (https://analyticsadmin.googleapis.com/v1alpha).
  • Proper permissions on the Google Analytics property are necessary to list custom dimensions.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Google Analytics API Credentials," ensure that OAuth2 credentials for Google Analytics API are properly set up in n8n.
  • Property ID Required: The operation requires a valid Property ID; missing this will cause an error.
  • API Errors: Errors from the Google Analytics API will be surfaced with messages prefixed by "Error calling Google Analytics API." Check the message and stack trace for details.
  • Pagination: If many custom dimensions exist, use Page Size and Page Token query parameters to paginate through results.
  • Soft-Deleted Items: By default, soft-deleted properties are included; adjust Show Deleted parameter if needed.

Links and References

Discussion