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 create new annotations within a specified Adobe Analytics company context. Annotations provide contextual notes or comments on data trends, helping analysts and teams document insights, events, or explanations directly linked to analytics data.
Typical use cases include:
- Adding explanatory notes to specific dates or data points in reports.
- Documenting marketing campaigns or website changes that might affect analytics.
- Collaborating across teams by sharing contextual information tied to analytics data.
For example, a marketing analyst could use this node to create an annotation marking the launch date of a new campaign, so future report viewers understand spikes or drops in traffic.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier for the Adobe Analytics company (tenant) where the annotation will be created. |
| Query Parameters | A collection of optional parameters to filter or modify the request. Includes many options such as approved, classifiable, componentId, endDate, limit, locale, startDate, useCache, and many others. These are mostly used for filtering or metadata enrichment but may not all apply to annotation creation. |
| Request Body | The JSON object representing the annotation details to create. This should contain the annotation content and any relevant metadata according to Adobe Analytics API specification. |
Note: For the "Create Annotation" operation, the main required inputs are the Global Company ID and the Request Body containing the annotation data.
Output
The node outputs the response from the Adobe Analytics API after creating the annotation. The output is a JSON array where each item corresponds to the API response for one input item.
- The
jsonfield contains the parsed JSON response from the API, typically including details of the newly created annotation such as its ID, timestamps, and content. - If the API returns no content, the node outputs a status code message like
"204 No Content". - The node does not output binary data.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
- The node authenticates using OAuth client credentials flow to obtain an access token before making API calls.
- Network access to
https://ims-na1.adobelogin.com/ims/token/v3for authentication andhttps://analytics.adobe.io/api/{globalCompanyId}for API requests.
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not set 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 get an access token, it throws "Failed to retrieve access token". Check client ID, secret, and network connectivity.
- Required Parameter Missing: For this operation, if
Global Company IDorRequest Bodyis missing or empty, the node will throw errors indicating the missing required parameter. - API Errors: Any API call failure results in an error with the message prefixed by "Error calling Adobe Analytics API:" followed by the original error message. Review the API response and ensure the request body and parameters conform to Adobe Analytics API requirements.
- Invalid JSON in Request Body: The
Request Bodymust be valid JSON. Invalid JSON will cause parsing errors.