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 retrieve various types of analytics data and metadata. Specifically, the "Get Top Items Report" operation under the "Report" resource runs a top items report, which is useful for identifying the most significant or highest-ranking items within a dataset based on specified criteria.
Common scenarios where this node is beneficial include:
- Marketing teams analyzing top-performing pages, products, or campaigns.
- Data analysts extracting key metrics to understand user behavior trends.
- Automated reporting workflows that require up-to-date top item lists from Adobe Analytics.
For example, you might use this node to fetch the top 10 most visited pages on a website during a specific date range or to identify the top-selling products in an e-commerce report suite.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier for the company in Adobe Analytics. Required for all operations except one specific user discovery operation. |
| Query Parameters | A collection of optional filters and settings to customize the report request. These include: |
| - Approved: Include only approved calculated metrics (boolean). | |
| - Classifiable: Include classifiable dimensions (boolean). | |
| - Component ID(s): Single or comma-separated list of component IDs to operate on (string). | |
| - Component Type: Filter by component type (string). | |
| - Curated RSID: Include curated item status for a given RSID (string). | |
| - Dimension: Dimension to run the report against (e.g., "variables/page") (string). | |
| - End Date / Start Date: Define the date range for the report, max 3 months (ISO8601 string). | |
| - Event / Event Type: Filter logs by event description or numeric event type ID (string). | |
| - Expansion: Add extra metadata to items (comma-delimited string). | |
| - Favorite: Include favorite calculated metrics (boolean). | |
| - Filter by Date Range / IDs / Modified After / Published Segments: Various filtering options (strings). | |
| - Include Type: Include additional annotations not owned by user ("all", "shared") (string). | |
| - IP / Login / User ID: Filters related to user or IP address (string or number). | |
| - Limit: Maximum number of results to return (number, min 1). | |
| - Locale: Locale setting, default "en_US" (string). | |
| - Lookup None Values: Whether to include none values (boolean). | |
| - Migrating: Include migration functions in validation (boolean). | |
| - Name / Tag Names / Segment Filter: Filters by name or tags (string). | |
| - New Definition: Use new JSON definition (boolean). | |
| - Owner ID: Filter projects owned by specified login ID (string). | |
| - Page: Pagination page number, base 0 (number). | |
| - Pagination: Whether to return paginated results (boolean). | |
| - Reportable / Segmentable: Include only valid dimensions for reports or segments (boolean). | |
| - RSID: Report suite ID filter (string). | |
| - Search And / Or / Not / Clause / Phrase: Various search term filters (strings). | |
| - Sort Direction: Sort order, either ASC or DESC. | |
| - Sort Property: Property to sort by (string). | |
| - To Be Used In RSID: Report suite where the calculated metric is intended to be used (string). | |
| - Use Cache: Whether to use caching for faster requests (boolean). |
Output
The node outputs an array of JSON objects representing the response from the Adobe Analytics API for the requested top items report. The structure depends on the API response but typically includes:
- The top items data according to the specified query parameters.
- Metadata about the report such as pagination info if enabled.
- Metrics and dimension values relevant to the top items.
If the API returns binary data (not typical for this operation), it would represent downloadable report files or similar content, but this node primarily handles JSON responses.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n, including:
- Client ID
- Client Secret
- Scope for API access
- The node obtains an OAuth2 access token via client credentials grant before making API calls.
- Network access to Adobe Analytics API endpoints (
https://analytics.adobe.ioandhttps://ims-na1.adobelogin.com).
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, the node will throw an error indicating missing credentials.
- Access Token Retrieval Failure: Failure to obtain an access token from Adobe's identity service will result in an error; verify client ID, secret, and scope.
- Required Parameter Missing: For some operations, required IDs (e.g., Annotation ID, Calculated Metric ID) must be provided; otherwise, the node throws an error.
- API Errors: Any errors returned by the Adobe Analytics API are wrapped and reported with details. Common issues include invalid parameters, permission errors, or rate limits.
- Empty or Unexpected Response: If the API returns empty or non-JSON responses, the node attempts to parse or returns raw text; ensure the request parameters are correct.
To resolve these issues:
- Double-check all required input properties.
- Confirm API credentials and permissions.
- Review API documentation for parameter constraints.
- Enable logging or inspect node execution logs for detailed error messages.