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 list annotations associated with a specified global company ID. It retrieves contextual notes or comments (annotations) that provide insights into data trends within Adobe Analytics reports. This operation is useful for users who want to programmatically access all annotations, filter them by various criteria such as date ranges, approval status, or ownership, and integrate this metadata into workflows for reporting, auditing, or analysis purposes.
Practical examples include:
- Automatically fetching all annotations created in the last month to review recent changes or comments.
- Filtering annotations by specific tags or owners to generate targeted reports.
- Integrating annotation data into dashboards or alerts to provide context alongside analytics metrics.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the Adobe Analytics company account to query against. Required for all requests. |
| Query Parameters | A collection of optional filters and options to refine the list of annotations returned. These include: |
| - Approved: Whether to include only approved calculated metrics (boolean). | |
| - Classifiable: Whether to include classifiable dimensions (boolean). | |
| - Component ID / Component IDs: Filter by one or multiple component IDs (string, comma-separated). | |
| - Component Type: Filter by component type (string). | |
| - Curated RSID: Include curated item status for a given report suite ID (string). | |
| - Dimension: Dimension to run the report against (e.g., "variables/page") (string). | |
| - End Date / Start Date: Date range boundaries for filtering annotations (ISO8601 string). | |
| - Event / Event Type: Filter logs by event description or numeric event type ID (string). | |
| - Expansion: Add extra metadata fields to items (comma-delimited string). | |
| - Favorite: Whether to include favorite calculated metrics (boolean). | |
| - Filter by Date Range / IDs / Modified After / Published Segments: Various filters to narrow results based on dates, IDs, modification time, or segment publication status (strings). | |
| - Include Type: Include additional annotations not owned by user; options include "all" or "shared" (string). | |
| - IP / Login / Owner ID / User ID: Filters based on user or IP address information (string or number). | |
| - Limit: Maximum number of results to return (number, minimum 1). | |
| - Locale: Locale code for returned data (default "en_US"). | |
| - Lookup None Values / Migrating / New Definition / Pagination / Reportable / Segmentable / Use Cache: Boolean flags controlling inclusion of certain data types or caching behavior. | |
| - Name / Tag Names / Search And / Search Clause / Search Not / Search Or / Search Phrase / Segment Filter / Sort Direction / Sort Property: Various search, filter, and sorting parameters (strings or enums). | |
| - Page: Page number for paginated results (base 0). |
Output
The output is a JSON array where each element represents an annotation object retrieved from Adobe Analytics. Each annotation includes metadata such as its ID, content, creation/modification dates, owner information, and any other fields requested via expansions or filters.
If the API returns no content, the node outputs a status message indicating "204 No Content".
No binary data is produced by this operation.
Dependencies
- Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
- The node obtains an OAuth2 access token from Adobe's IMS token endpoint before making API calls.
- Network connectivity to
https://analytics.adobe.ioandhttps://ims-na1.adobelogin.comis required.
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials".
- Access Token Retrieval Failure: Failure to obtain an access token results in "Failed to retrieve access token". Check client ID, secret, and scope correctness.
- Required Parameter Missing: For operations requiring an annotation ID, if it is not provided, the node throws an error like "Annotation ID is required".
- API Errors: Any HTTP or API errors are wrapped and reported with messages prefixed by "Error calling Adobe Analytics API:" along with stack traces if available.
- Empty or Invalid Responses: If the response is empty or cannot be parsed as JSON, the node attempts to return raw text or a 204 status message.
To resolve issues:
- Verify all required input properties are correctly set.
- Ensure API credentials have proper permissions.
- Confirm network access to Adobe endpoints.
- Review API limits and usage quotas.