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 interacts with the Adobe Analytics API to retrieve and manage annotations, which provide contextual information about data trends. Specifically, the "Get Annotation" operation fetches details of a single annotation by its ID within a specified global company context.
Use cases include:
- Retrieving detailed information about a specific annotation to understand the context behind certain analytics data points.
- Integrating annotation data into automated reporting or dashboards for enhanced insights.
- Auditing or reviewing annotations related to marketing campaigns or website changes.
Example: Fetching an annotation by its ID to display its content alongside relevant analytics reports.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the company in Adobe Analytics under which the annotation exists. |
| Annotation ID | The unique identifier of the annotation to retrieve. |
| Query Parameters | Optional filters and parameters to refine the request. Includes options such as: |
| - Approved (boolean): Include only approved calculated metrics. | |
| - Classifiable (boolean): Include classifiable dimensions. | |
| - Component ID(s) (string): Filter by one or multiple component IDs. | |
| - Component Type (string): Filter by component type. | |
| - Curated RSID (string): Include curated item status for given report suite ID. | |
| - Dimension (string): Dimension to run the report against. | |
| - End Date / Start Date (string): Date range limits for filtering annotations. | |
| - Event / Event Type (string): Filter logs by event description or type. | |
| - Expansion (string): Add extra metadata to items (comma-separated). | |
| - Favorite (boolean): Include favorite calculated metrics. | |
| - Filter by Date Range / Modified After / Published Segments (string): Various date/segment filters. | |
| - Include Type (string): Include additional annotations not owned by user ("all" or "shared"). | |
| - IP, Login, User ID (string/number): Filters based on user or IP address. | |
| - Limit (number): Maximum number of results to return. | |
| - Locale (string): Locale setting, e.g., "en_US". | |
| - Pagination (boolean): Whether to paginate results. | |
| - Sort Direction (ASC/DESC) and Sort Property (string): Sorting options. | |
| - Tag Names, Search terms, Segment filters, and other advanced filtering options. |
Output
The output is a JSON array containing the retrieved annotation data from Adobe Analytics. The structure corresponds directly to the API response for a single annotation, typically including fields such as annotation content, creation/modification dates, author information, and any associated metadata.
If the API returns no content, the node outputs a status code message indicating "204 No Content".
No binary data output is involved in this operation.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n, providing:
- Client ID
- Client Secret
- Scope for API access
- The node obtains an OAuth2 access token via Adobe's IMS token endpoint before making API requests.
- Network access to
https://analytics.adobe.ioandhttps://ims-na1.adobelogin.comis 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: The "Annotation ID" property is mandatory for this operation. Omitting it will cause an error.
- Access Token Retrieval Failure: Failure to obtain an access token from Adobe IMS will result in an error; verify client credentials and network connectivity.
- API Errors: Any errors returned by the Adobe Analytics API will be surfaced with descriptive messages. Common issues include invalid IDs, insufficient permissions, or malformed query parameters.
- Empty Response: A "204 No Content" status indicates no annotation was found or available for the given parameters.