Actions57
- Annotation Actions
- Calculated Metric Actions
- Component Meta Data Actions
- Add Tags
- Delete Multiple Tags
- Delete One Tag
- Delete Shared Component
- Get Shared Component
- Get Tag
- List Shared Components by the User
- List Shared Components to the User
- List Tag Names
- List Tags
- Save Tags
- Search Shared Components
- Search Tags for Multiple Components
- Search Tags for One Component
- Share Component with Multiple User
- Share Component with One User
- Date Range Actions
- Dimension Actions
- Metric Actions
- Project Actions
- Report Actions
- Segment Actions
- Usage Log Actions
- User Actions
Overview
This node integrates with the Adobe Analytics API to manage annotations, which provide contextual information about data trends. Specifically, the "Update Annotation" operation allows users to modify existing annotations by specifying the annotation ID and providing updated content in the request body.
Use cases include:
- Updating notes or comments attached to specific data points or time periods to reflect new insights.
- Correcting or refining annotation details to improve report clarity.
- Maintaining up-to-date context for team members analyzing Adobe Analytics data.
Example: You have an annotation explaining a traffic spike on a certain date; you can update it to add more details or correct errors without creating a new annotation.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the company in Adobe Analytics under which the annotation exists. Required for all operations except user discovery. |
| Annotation ID | The unique identifier of the annotation to update. Required for update, get, and delete operations on annotations. |
| Query Parameters | Optional parameters to filter or modify the request. Includes many options such as approved, classifiable, componentId, endDate, limit, locale, page, sortDirection (ASC/DESC), startDate, and others that refine the query or response. |
| Request Body | JSON object containing the updated annotation data. This is the main payload for the update operation and should conform to Adobe Analytics API's annotation update schema. |
Output
The output is a JSON array where each element corresponds to the response from the Adobe Analytics API for the executed update request. For the "Update Annotation" operation, the output typically contains the updated annotation object reflecting the changes made.
If the API returns no content (HTTP 204), the output will indicate "Status Code": "204 No Content".
No binary data output is produced by this node.
Dependencies
- Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
- The node obtains an OAuth access token via Adobe's IMS token endpoint using client credentials flow.
- Network access to
https://ims-na1.adobelogin.com/ims/token/v3andhttps://analytics.adobe.io/api/endpoints is required.
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, the node will throw an error indicating missing credentials.
- Invalid or Missing Annotation ID: For update operations, if the annotation ID is not provided, the node throws an error stating that the annotation ID is required.
- Access Token Retrieval Failure: If the OAuth token cannot be retrieved, the node will fail with an error about failing to retrieve the access token. Check client ID, secret, and network connectivity.
- API Errors: Any API call failure will result in an error message prefixed with "Error calling Adobe Analytics API" including the original error message and stack trace if available.
- Malformed Request Body: Ensure the JSON in the request body is valid and matches the expected schema for updating annotations.