Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to manage component metadata, specifically allowing users to add tags to components. The "Add Tags" operation enables tagging one or multiple components at once, replacing any existing tag associations for those components. This is useful in scenarios where you want to organize, categorize, or label components (such as dimensions, metrics, or segments) within Adobe Analytics for easier identification and filtering.

Practical examples include:

  • Tagging a set of report components to group them by project or theme.
  • Updating tags on components to reflect changes in business priorities.
  • Automating the management of metadata tags across multiple components in bulk.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics under which the components exist. Required for all operations except some user discovery operations.
Query Parameters A collection of optional parameters to filter or modify the request. Includes many options such as componentId, componentIds (comma-separated list), componentType, pagination controls (limit, page), sorting options, date filters, and more.
Request Body JSON object containing the data to send in the body of the request. For the "Add Tags" operation, this would typically include the tags to associate with the specified components.

Notable Query Parameters (selected relevant ones):

  • componentId: The single component ID to operate on.
  • componentIds: Comma-separated list of component IDs to operate on.
  • componentType: Type of component to return or operate on.
  • limit: Maximum number of results to return.
  • page: Page number for paginated results.
  • sortDirection: Sort order, either ASC or DESC.
  • sortProperty: Property name to sort by.
  • tagNames: Filter list to only include components that contain one of the specified tags.

The full list of query parameters is extensive and supports detailed filtering and control over the API requests.

Output

The output is an array of JSON objects representing the response from the Adobe Analytics API for the "Add Tags" operation. Typically, this will confirm the success of the tagging operation or provide details about the updated tag associations.

  • If the API returns JSON data, it is parsed and returned as JSON.
  • If the API returns a string, the node attempts to parse it as JSON; if parsing fails, it returns the raw text.
  • If no content is returned (HTTP 204), the node outputs a status message indicating "204 No Content".
  • The output does not include binary data.

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
  • The node authenticates using OAuth client credentials flow to obtain an access token before making API calls.
  • Network access to Adobe Analytics API endpoints is required.

Troubleshooting

  • Missing Credentials Error: If the Adobe Analytics API credentials are not provided or incomplete, the node throws an error "Missing Adobe Analytics API Credentials". Ensure credentials are properly configured.
  • Access Token Retrieval Failure: If the node cannot retrieve an access token, it throws "Failed to retrieve access token". Check client ID, client secret, and scope values.
  • Required Parameter Missing: For the "Add Tags" operation, if required parameters like component IDs are missing, the node will throw errors indicating which parameter is required.
  • API Errors: Any HTTP or API errors are caught and rethrown as node errors with messages prefixed by "Error calling Adobe Analytics API". Review the error message and stack trace for details.
  • Invalid JSON in Request Body: The request body must be valid JSON when sending data; otherwise, the request will fail.

Links and References

Discussion