Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node interacts with the Adobe Analytics API to retrieve detailed information about calculated metric functions. Specifically, the "Get Calculated Metric Function" operation fetches a single calculated metric function by its unique ID within a specified global company context.

Use cases include:

  • Retrieving metadata and definitions of calculated metric functions for analysis or reporting.
  • Integrating Adobe Analytics calculated metric functions into automated workflows.
  • Validating or inspecting specific calculated metric functions programmatically.

For example, a marketing analyst might use this node to fetch the formula and details of a custom calculated metric used in reports, enabling further processing or validation in an n8n workflow.

Properties

Name Meaning
Global Company ID The identifier of the global company under which the calculated metric function exists. This is required to scope the API request correctly.
Calculated Metric Function ID The unique identifier of the calculated metric function to retrieve. This is required to specify which function's details to fetch.
Query Parameters Optional additional parameters to filter or modify the request. These include various filters such as approval status, date ranges, pagination options, sorting preferences, and other metadata flags. See below for some examples:
- Approved Whether to include only approved calculated metrics (boolean).
- Favorite Whether to include only favorite calculated metrics (boolean).
- Limit Maximum number of results to return (number).
- Sort Direction Sorting order of results, either ascending (ASC) or descending (DESC).
- Start Date / End Date Date range boundaries for filtering data (ISO8601 string).
- Use Cache Whether to use caching for faster requests (boolean).
... Many other optional query parameters are available to refine the request, including component IDs, dimension filters, search clauses, segment filters, and more.

Output

The node outputs the JSON response from the Adobe Analytics API corresponding to the requested calculated metric function. This typically includes:

  • The function's unique ID.
  • Its name and description.
  • The formula or definition of the calculated metric function.
  • Metadata such as creation/modification dates, approval status, and usage information.
  • Any additional properties returned by the API related to the calculated metric function.

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

No binary data output is produced by this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with appropriate permissions.
  • The node uses OAuth client credentials flow to obtain an access token from Adobe Identity Management Service.
  • Network access to https://ims-na1.adobelogin.com/ims/token/v3 for authentication and https://analytics.adobe.io/api/{globalCompanyId} for API calls.
  • Proper configuration of the credential with client ID, client secret, and scope is necessary.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Adobe Analytics API Credentials", ensure that the Adobe Analytics API credential is properly set up in n8n and selected in the node.
  • Failed to Retrieve Access Token: Indicates issues with client ID, client secret, or scope. Verify these values in the credential configuration.
  • Required ID Missing: If the "Calculated Metric Function ID" is not provided, the node will throw an error. Make sure to supply this property.
  • API Errors: Any errors returned by the Adobe Analytics API will be wrapped and reported by the node. Check the error message and stack trace for details.
  • Empty or Unexpected Response: If the API returns empty or unexpected data, verify the correctness of the IDs and query parameters used.

Links and References

This summary focuses on the "Get Calculated Metric Function" operation of the Adobe Analytics node, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static code analysis.

Discussion