Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to perform various operations related to calculated metrics, including validating a calculated metric definition. The "Validate Calculated Metric Definition" operation allows users to check if a JSON definition of a calculated metric is valid according to Adobe Analytics rules before creating or updating it. This validation helps prevent errors in metric definitions that could cause issues in reports or analyses.

Common scenarios for this node include:

  • Validating new or updated calculated metric definitions programmatically as part of an automated workflow.
  • Ensuring metric definitions conform to Adobe Analytics standards before deployment.
  • Integrating metric validation into CI/CD pipelines for analytics configurations.

Example use case:

  • A marketing analyst prepares a complex calculated metric JSON definition and uses this node to validate it automatically before applying it to their Adobe Analytics workspace.

Properties

Name Meaning
Global Company ID The unique identifier of the Adobe Analytics company (global company) under which the API requests are made.
Query Parameters A collection of optional parameters to filter or modify the request. Includes options such as: Approved, Classifiable, Component ID(s), Component Type, Curated RSID, Dimension, Date Range (startDate, endDate), Event filters, Favorite, Limit, Locale, Pagination, Sort options, and many others. These parameters allow fine-tuning of the data retrieval or validation context.
Request Body The JSON object representing the calculated metric definition to be validated. This should contain the metric's formula and configuration details as per Adobe Analytics API requirements.

Output

The output is a JSON array where each element corresponds to the response from the Adobe Analytics API for the validation request. The structure typically includes:

  • Validation results indicating whether the calculated metric definition is valid.
  • Error messages or warnings if the definition contains issues.
  • Metadata about the validation process.

If the API returns no content, the node outputs a status code message like "204 No Content".

No binary data output is involved in this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
  • The node makes authenticated HTTP requests to Adobe's IMS token service to obtain an access token.
  • Uses the Adobe Analytics REST API endpoint https://analytics.adobe.io/api/{globalCompanyId}/calculatedmetrics/validate for validation.
  • Requires internet connectivity and proper permissions on the Adobe Analytics account.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials". Ensure credentials are correctly configured.
  • Access Token Retrieval Failure: Errors like "Failed to retrieve access token" indicate issues with authentication. Verify client ID, client secret, and scope values.
  • Required Parameter Missing: For this operation, the Global Company ID and Request Body must be provided. Omitting these will cause errors.
  • API Errors: If the validation fails due to incorrect JSON definition, the API response will include error details. Review the returned messages to correct the metric definition.
  • Network Issues: Connectivity problems can cause request failures. Check network access and proxy settings if applicable.

Links and References

This summary focuses specifically on the "Validate Calculated Metric Definition" operation within the "Calculated Metric" resource of the Adobe Analytics node.

Discussion