Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node interacts with the Adobe Analytics API to manage shared components metadata. Specifically, the "Delete Shared Component" operation deletes a shared component by its unique shared component ID within a specified global company context. This is useful for organizations that collaborate on analytics components and need to revoke or remove shared access to certain components.

Practical scenarios include:

  • Removing obsolete or incorrect shared components from the system.
  • Managing access control by deleting shares no longer needed.
  • Cleaning up shared resources in bulk or individually.

Properties

Name Meaning
Global Company ID The identifier of the global company under which the shared component exists (required).
Shared Component ID The unique identifier of the shared component to delete (required for this operation).
Query Parameters Optional additional parameters to filter or modify the request behavior (various options).

The Query Parameters collection includes many optional filters and flags such as:

  • approved, favorite (booleans): Flags to include approved or favorite calculated metrics.
  • componentId, componentIds (strings): Specific component IDs to operate on.
  • componentType (string): Type of component to return.
  • Date filters like startDate, endDate.
  • Pagination controls like limit, page, pagination.
  • Sorting options: sortDirection (ASC/DESC), sortProperty.
  • Various other filters related to segments, events, users, etc.

For the "Delete Shared Component" operation, only the Global Company ID and Shared Component ID are strictly required; query parameters are generally not used.

Output

The output is a JSON array where each element corresponds to the response from the Adobe Analytics API for the deletion request.

  • On successful deletion, the API typically returns a status code indicating success (e.g., 204 No Content).
  • If the response contains data, it will be parsed and returned as JSON.
  • If the response is empty or just a status code, the node outputs an object indicating the status code (e.g., "Status Code": "204 No Content").

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for Adobe Analytics API authentication.
  • Uses OAuth client credentials flow to obtain an access token before making API calls.
  • The node expects valid Adobe Analytics API credentials configured in n8n.
  • Network access to https://ims-na1.adobelogin.com/ims/token/v3 for token retrieval and https://analytics.adobe.io/api/{globalCompanyId} for API requests.

Troubleshooting

  • Missing Credentials Error: If the Adobe Analytics API credentials are not set or invalid, the node throws an error "Missing Adobe Analytics API Credentials". Ensure credentials are properly configured.
  • Access Token Retrieval Failure: If the OAuth token cannot be obtained, the node throws "Failed to retrieve access token". Check client ID, secret, and scope correctness.
  • Required Parameter Missing: For this operation, if the Shared Component ID or Global Company ID is missing, the node throws an error indicating the missing parameter.
  • API Errors: Any HTTP errors or API failures are caught and rethrown with descriptive messages including the original error message and stack trace.
  • Empty or Unexpected Responses: The node attempts to parse string responses as JSON; if parsing fails, it returns raw text. If no content is returned, it outputs a status code message.

Links and References

Discussion