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 run various operations related to analytics data management. Specifically, for the Report resource and the Run Realtime Report operation, it allows users to execute real-time reports against their Adobe Analytics data. This is useful for scenarios where immediate insights into current user activity or events are needed, such as monitoring live website traffic, tracking campaign performance in real time, or quickly validating changes in data collection.
Practical examples include:
- Running a real-time report to see how many users are currently active on a site.
- Filtering real-time data by specific dimensions like page or event type.
- Using query parameters to customize the scope and detail of the report output.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier for the company within Adobe Analytics. Required to specify the context for the API request. |
| Query Parameters | A collection of optional filters and settings to customize the report query. Options include: - Approved (boolean): Include only approved calculated metrics. - Classifiable (boolean): Include classifiable dimensions. - Component ID(s) (string): Filter by component IDs. - Component Type (string): Specify component type. - Curated RSID (string): Include curated item status. - Dimension (string): Dimension to run the report against (e.g., "variables/page"). - End Date (string): End date for the report period. - Event/Event Type (string): Filter logs by event description or numeric event type ID. - Expansion (string): Add extra metadata. - Favorite (boolean): Include favorite calculated metrics. - Filter by Date Range/IDs/Modified After/Published Segments (string): Various filtering options. - Include Type (string): Include additional annotations ("all" or "shared"). - IP/Login/User ID (string/number): Filter logs by user or IP. - Limit (number): Max number of results. - Locale (string): Locale setting. - Lookup None Values (boolean): Include none values. - Migrating (boolean): Include migration functions. - Name (string): Filter segments by name. - New Definition (boolean): Use new JSON definition. - Owner ID (string): Filter projects by owner. - Page (number): Pagination page number. - Pagination (boolean): Enable pagination. - Reportable/Segmentable (boolean): Include only valid dimensions. - RSID (string): Report suite ID. - Search And/Or/Not/Phrase/Clause (string): Search terms. - Segment Filter (string): Filter segments. - Sort Direction (ASC/DESC): Sorting order. - Sort Property (string): Property to sort by. - Start Date (string): Start date for the report period. - Tag Names (string): Filter segments by tags. - To Be Used In RSID (string): Target report suite for calculated metric. - Use Cache (boolean): Use caching for faster requests. |
| Request Body | JSON object representing the body of the POST request sent to the Adobe Analytics API. For the realtime report operation, this contains the detailed report request payload specifying metrics, dimensions, segments, etc. |
Output
The node outputs an array of JSON objects representing the response from the Adobe Analytics API for the realtime report request. The structure of the JSON depends on the Adobe Analytics API's realtime report response format, typically including:
- Metrics and dimensions data reflecting the real-time analytics.
- Metadata about the report execution.
- Possible pagination information if enabled.
If the API returns binary data (not typical for this operation), it would be handled accordingly, but this node primarily deals with JSON responses.
Dependencies
- Requires an API key credential for Adobe Analytics with client ID, client secret, and scope configured.
- The node performs OAuth2 client credentials flow to obtain an access token from Adobe Identity Management System.
- Network access to
https://ims-na1.adobelogin.comfor token retrieval andhttps://analytics.adobe.io/api/{globalCompanyId}for API calls. - Proper permissions in Adobe Analytics to run realtime reports.
Troubleshooting
- Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Adobe Analytics API credentials (client ID, secret, scope) are correctly set up in n8n.
- Failed to Retrieve Access Token: Indicates issues with authentication; verify client ID, secret, and scope correctness.
- Required Parameter Missing: Errors like "Global Company ID is required" mean mandatory inputs were not provided.
- API Request Failures: Could be due to invalid query parameters, malformed request body, or insufficient permissions. Check the request payload and parameters carefully.
- Rate Limiting or Quotas: Adobe Analytics API may limit request rates; handle errors gracefully and consider retry logic.
- Unexpected Response Format: If the response cannot be parsed as JSON, check if the API endpoint or parameters are correct.