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 list metric definitions for a specified company. It allows users to retrieve detailed information about available metrics, which can be used to build and validate analytics queries or reports. This operation is beneficial when you want to explore or filter the set of metrics accessible in your Adobe Analytics environment, such as fetching approved or favorite metrics, filtering by report suite ID, or applying various other query parameters.
Practical examples include:
- Retrieving all approved metrics for a specific company to understand what data points are available.
- Filtering metrics by certain tags or component IDs to narrow down relevant metrics for reporting.
- Using pagination and sorting options to manage large sets of metrics efficiently.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the company within Adobe Analytics for which metrics are being requested. |
| Query Parameters | A collection of optional filters and settings to refine the list of returned metrics. These include: |
| - Approved: Include only approved calculated metrics (boolean). | |
| - Classifiable: Include classifiable dimensions (boolean). | |
| - Component ID / Component IDs: Filter by one or multiple component IDs (string). | |
| - Component Type: Filter by component type (string). | |
| - Curated RSID: Include curated item status for a given report suite ID (string). | |
| - Dimension: Specify dimension to run the report against (string). | |
| - End Date / Start Date: Define date range limits for filtering (ISO8601 string). | |
| - Event / Event Type: Filter logs by event description or numeric event type ID (string). | |
| - Expansion: Add extra metadata fields to items (comma-separated string). | |
| - Favorite: Include only favorite calculated metrics (boolean). | |
| - Filter by Date Range / Filter by IDs / Filter by Modified After / Filter by Published Segments: Various filters for annotations, segments, or modification dates (string). | |
| - Include Type: Include additional annotations not owned by user; options include "all" or "shared" (string). | |
| - IP / Login / User ID: Filters based on IP address, login value, or user ID (string/number). | |
| - Limit: Maximum number of results to return (number). | |
| - Locale: Locale setting, default is "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 based on names or tags (string). | |
| - New Definition: Use new JSON definition format (boolean). | |
| - Owner ID: Filter projects owned by a specific login ID (string). | |
| - Page: Pagination page number, zero-based (number). | |
| - Pagination: Whether to paginate results (boolean). | |
| - Reportable / Segmentable: Include only dimensions valid within reports or segments (boolean). | |
| - RSID: Report suite ID to filter logs by (string). | |
| - Search And / Or / Not / Clause / Phrase: Various search term filters (string). | |
| - Sort Direction: Sort order, either ASC or DESC (options). | |
| - Sort Property: Property name 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 output is a JSON array containing the list of metric objects retrieved from the Adobe Analytics API. Each object represents a metric definition with its associated properties as returned by the API. The exact structure depends on the Adobe Analytics API response but typically includes metric identifiers, names, descriptions, approval status, and other metadata.
If the API returns no content, the node outputs a status message indicating "204 No Content".
No binary data output is produced by this operation.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n that provides:
- Client ID
- Client Secret
- Scope for authentication
- The node performs OAuth2 client credentials flow to obtain an access token from Adobe's IMS token endpoint.
- Network access to
https://ims-na1.adobelogin.com/ims/token/v3for token retrieval and tohttps://analytics.adobe.io/api/{globalCompanyId}for API calls.
Troubleshooting
- Missing Credentials Error: If the node throws "Missing Adobe Analytics API Credentials", ensure that the Adobe Analytics API credential is properly set up in n8n with valid client ID, secret, and scope.
- Failed to Retrieve Access Token: Indicates issues with authentication; verify credentials and network connectivity.
- Required Parameter Missing: For this operation, the "Global Company ID" must be provided; missing it will cause an error.
- API Errors: Any errors returned by the Adobe Analytics API will be wrapped and reported with the message "Error calling Adobe Analytics API" along with details. Check the API request parameters and permissions.
- Empty or Unexpected Response: If the response is empty or cannot be parsed, check if the query parameters are correct and if the account has access to the requested data.