Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node operation deletes an existing annotation in Adobe Analytics. Annotations provide contextual notes or comments on data trends, helping analysts and teams understand changes or events affecting the data.

Use cases include:

  • Removing outdated or incorrect annotations from your Adobe Analytics workspace.
  • Cleaning up annotations that are no longer relevant to current reports or projects.
  • Managing annotation lifecycle programmatically as part of automated workflows.

For example, if an annotation was added to mark a marketing campaign launch but later found to be inaccurate, this node can delete it automatically based on its Annotation ID.

Properties

Name Meaning
Global Company ID The unique identifier for your Adobe Analytics company account.
Annotation ID The unique identifier of the annotation you want to delete. This is required.
Query Parameters Optional additional parameters to filter or modify the request (not typically used here).

The "Query Parameters" collection includes many optional fields for other operations but are generally not applicable for deleting an annotation.

Output

The output is a JSON array containing the response from the Adobe Analytics API after attempting to delete the annotation.

  • If successful, the response may be empty or contain status information.
  • If the API returns a string response, it attempts to parse it as JSON; otherwise, it outputs raw text.
  • If no content is returned (HTTP 204), the output will indicate "Status Code": "204 No Content".

No binary data is involved in this operation.

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
  • The node authenticates via OAuth client credentials flow to obtain an access token.
  • Network access to https://ims-na1.adobelogin.com/ims/token/v3 for authentication and https://analytics.adobe.io/api/{globalCompanyId}/annotations/{annotationId} for the delete request.

Troubleshooting

  • Missing Credentials: The node throws an error if Adobe Analytics API credentials are not set or incomplete.
  • Missing Annotation ID: Deleting requires specifying the Annotation ID; omitting it causes an error.
  • Failed Access Token Retrieval: If the OAuth token cannot be obtained, the node will fail with an authentication error.
  • API Errors: Any errors returned by the Adobe Analytics API (e.g., invalid ID, permission denied) will be surfaced as node errors with descriptive messages.
  • Network Issues: Connectivity problems to Adobe endpoints will cause request failures.

To resolve issues:

  • Ensure valid Adobe Analytics API credentials are configured.
  • Provide a correct Annotation ID.
  • Verify network connectivity and API permissions.

Links and References

Discussion