Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node interacts with the Adobe Analytics API to retrieve metadata about components, specifically tags in this context. The "Get Tag" operation under the "Component Meta Data" resource fetches detailed information about a specific tag by its ID. This is useful when you want to obtain metadata related to tags that are associated with various components such as dimensions, metrics, or segments within Adobe Analytics.

Practical scenarios include:

  • Retrieving tag details to understand how components are categorized or labeled.
  • Using tag metadata to filter or organize analytics components dynamically in workflows.
  • Integrating tag information into reporting or data processing pipelines for enhanced context.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics. Required to specify the scope of the request.
Tag ID The unique identifier of the tag to retrieve. This is required to fetch the specific tag's metadata.
Query Parameters Optional parameters to refine or modify the request. These include a wide range of filters and options such as: approved (include approved metrics), classifiable (include classifiable dimensions), componentId(s), componentType, date ranges, pagination controls, sorting options, locale, and many others. These parameters allow fine-tuning the returned data according to specific needs.

The "Query Parameters" collection supports many optional fields; some notable ones relevant to tags and components include:

  • componentId / componentIds: Filter by specific component IDs.
  • componentType: Specify the type of component to return.
  • limit, page, pagination: Control paging of results.
  • sortDirection, sortProperty: Define sorting order and property.
  • locale: Language/locale for returned data.
  • Various filters for dates, names, ownership, and usage context.

Output

The output is a JSON array where each item corresponds to the response from the Adobe Analytics API for the requested tag. The structure depends on the Adobe Analytics API response for a tag but typically includes:

  • Tag metadata such as ID, name, description, creation/modification timestamps.
  • Associations of the tag with components.
  • Additional metadata fields depending on query parameters and API version.

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

No binary data output is expected from this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
  • The node obtains an OAuth access token via Adobe IMS token endpoint before making API calls.
  • Network connectivity to Adobe Analytics API endpoints is necessary.

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".
  • Access Token Retrieval Failure: Failure to get an access token results in "Failed to retrieve access token". Check credentials and network connectivity.
  • Required Parameter Missing: If the Tag ID is not provided for the "Get Tag" operation, the node throws "Tag ID is required".
  • API Errors: Any errors returned by the Adobe Analytics API are wrapped and reported with the message prefix "Error calling Adobe Analytics API". Review the error message and stack trace for details.
  • Invalid Query Parameters: Providing unsupported or malformed query parameters may cause API errors. Validate parameters against Adobe Analytics API documentation.

Links and References

Discussion