Google Analytics icon

Google Analytics

Use the Google Analytics API

Actions236

Admin (V1Alpha) - Reporting Data Annotation → List Reporting Data Annotations

AI-generated

Overview

This node interacts with the Google Analytics API, specifically targeting the "Admin (V1Alpha) - Reporting Data Annotation" resource to list reporting data annotations within a specified property. It allows users to retrieve metadata annotations related to reporting data, which can be useful for understanding or managing custom notes or comments attached to analytics reports.

Common scenarios where this node is beneficial include:

  • Auditing or reviewing annotations made on reporting data for a Google Analytics property.
  • Automating the retrieval of reporting data annotations for further processing or integration with other systems.
  • Monitoring changes or notes added to analytics reports to maintain data governance.

Example use case:

  • A marketing analyst wants to fetch all reporting data annotations for a specific property to generate a summary report of recent changes or comments made by team members.

Properties

Name Meaning
Property ID The identifier of the Google Analytics property from which to list reporting data annotations. This is required to specify the scope of the request.
Query Parameters Optional parameters to filter or paginate the list of reporting data annotations. Includes:
- Calculated Metric ID: Filter by calculated metric.
- 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 annotations to return.
- Page Token: Token for fetching next page.
- Show Deleted: Include soft-deleted properties.
- Universal Analytics Property ID: Lookup connected GA4 property.
- Update Mask: Fields to update (snake case).

Output

The node outputs a JSON array containing the list of reporting data annotations retrieved from the Google Analytics API for the specified property. Each item in the array represents a reporting data annotation object as returned by the API, including details such as annotation content, timestamps, and associated metadata.

No binary data output is involved.

Dependencies

  • Requires an OAuth2 API credential configured for Google Analytics API access.
  • The node uses the Google Analytics Admin API endpoint https://analyticsadmin.googleapis.com/v1alpha for this resource.
  • Proper permissions on the Google Analytics property are necessary to list reporting data annotations.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid Google Analytics OAuth2 credential is configured and selected.
  • Property ID Required: The node requires a Property ID to function. If omitted, it will throw an error indicating the Property ID is required.
  • API Errors: Errors returned from the Google Analytics API (e.g., permission denied, invalid parameters) will be surfaced with messages prefixed by "Error calling Google Analytics API". Check the API response and verify permissions and parameter correctness.
  • Pagination Handling: If many annotations exist, use the Page Token query parameter 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