Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to retrieve and manage calculated metrics, among other resources. Specifically, the "Get Calculated Metric" operation fetches a single calculated metric by its ID for a specified global company. This is useful when you want to programmatically access detailed definitions or metadata of a particular calculated metric within your Adobe Analytics environment.

Common scenarios include:

  • Automating retrieval of calculated metric details for reporting or auditing.
  • Integrating calculated metric data into workflows for further processing or visualization.
  • Validating or synchronizing calculated metrics across different environments.

Example: You have a calculated metric defined in Adobe Analytics that measures a custom conversion rate. Using this node, you can fetch its definition and use it in automated reports or dashboards.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics context. Required to specify which company's data to access.
Calculated Metric ID The unique identifier of the calculated metric to retrieve. Required for fetching a specific calculated metric.
Query Parameters Optional filters and parameters to refine the request. Includes options such as: Approved (include only approved metrics), Favorite (include favorites), Pagination controls, Date ranges, Sorting options, Locale, and many others to customize the query.

The Query Parameters collection supports many optional fields to filter or modify the request, including but not limited to:

  • approved: Whether to include only approved calculated metrics.
  • favorite: Whether to include only favorite calculated metrics.
  • limit: Maximum number of results to return.
  • page: Page number for paginated results.
  • sortDirection: Sort order, either ASC or DESC.
  • startDate / endDate: Date range filters.
  • Various filters on components, events, segments, tags, and user IDs.

Output

The output is a JSON array where each item corresponds to the response from the Adobe Analytics API for the requested calculated metric(s).

For the "Get Calculated Metric" operation, the JSON output contains the detailed information about the specified calculated metric, including its definition, metadata, status, and usage context.

If the API returns no content (e.g., 204 No Content), the node outputs an object indicating this status.

No binary data output is produced by this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with appropriate permissions.
  • The node authenticates using OAuth client credentials flow to obtain an access token.
  • Network access to Adobe's IMS token endpoint and Adobe Analytics API endpoints is required.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Adobe Analytics API credential is properly set up in n8n with valid client ID, client secret, and scope.
  • Access Token Retrieval Failure: Errors retrieving the access token usually indicate invalid credentials or network issues. Verify credentials and connectivity.
  • Required Parameter Missing: For this operation, the "Calculated Metric ID" and "Global Company ID" must be provided. Omitting these will cause errors.
  • API Errors: Any API call failure will throw an error with the message returned by Adobe Analytics API. Check the error message and stack trace for details.
  • Empty or Unexpected Response: If the response is empty or cannot be parsed as JSON, verify that the requested calculated metric ID exists and that query parameters are correct.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion