Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Property → Get Property Data Retention Settings

AI-generated

Overview

This node interacts with the Google Analytics API, specifically targeting the Admin (V1Alpha) resource for managing properties. The "Get Property Data Retention Settings" operation retrieves the data retention settings configured for a specified Google Analytics property. This is useful for administrators who want to audit or verify how long user and event data is retained within their analytics properties.

Common scenarios include:

  • Auditing data retention policies for compliance.
  • Verifying current retention settings before making changes.
  • Integrating retention settings checks into automated workflows for governance.

Example: An organization wants to ensure that all their Google Analytics properties retain user data only for a maximum of 14 months. Using this node operation, they can fetch the current retention settings for each property and flag any that exceed this limit.

Properties

Name Meaning
Property ID The unique identifier of the Google Analytics property whose data retention settings are to be retrieved.
Query Parameters Optional parameters to refine the request. Includes options like Calculated Metric ID, Entity, Filter, Names, Page Size, Page Token, Show Deleted, Universal Analytics Property ID, Update Mask.

The "Query Parameters" collection allows adding optional filters or pagination controls but is generally not required for this specific operation.

Output

The output JSON contains the data retention settings of the specified property as returned by the Google Analytics Admin API. This typically includes fields such as retention duration, reset conditions, and scope of data retention.

The exact structure depends on the API response but generally provides detailed configuration about how long user and event data is kept before automatic deletion.

No binary data output is involved in this operation.

Dependencies

  • Requires an OAuth2 credential 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 account/property are necessary to retrieve data retention settings.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid Google Analytics OAuth2 API credential is configured in n8n.
  • Property ID Required: The operation requires a Property ID; if omitted, the node will throw an error indicating this requirement.
  • API Permission Errors: Insufficient permissions on the Google Analytics property may result in authorization errors. Verify that the authenticated user has appropriate admin rights.
  • Invalid Property ID: Providing an incorrect or non-existent Property ID will cause the API call to fail. Double-check the Property ID value.
  • Network or API Errors: General API errors will be reported with messages prefixed by "Error calling Google Analytics API". Check network connectivity and API quota limits.

Links and References

This summary focuses on the "Admin (V1Alpha) - Property" resource and the "Get Property Data Retention Settings" operation as requested.

Discussion