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 calculated metrics within a specified global company context. It allows users to retrieve multiple calculated metrics based on various filtering and sorting criteria, enabling enhanced data analysis by leveraging predefined or custom calculated metrics.
Common scenarios where this node is beneficial include:
- Fetching all approved calculated metrics for a company to analyze performance indicators.
- Filtering calculated metrics by specific components, report suites, or usage status.
- Retrieving favorite or curated calculated metrics for quick access in reporting workflows.
Practical example:
- A marketing analyst wants to list all approved and favorite calculated metrics related to a particular report suite to build a dashboard. They can use this node to fetch those metrics filtered by approval status, favorites, and report suite ID.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the global company under which the calculated metrics are managed. Required for API calls. |
| Query Parameters | A collection of optional filters and options to refine the list of calculated metrics returned. These include: |
| - Approved | Whether to include only approved calculated metrics (true/false). |
| - Classifiable | Whether to include classifiable dimensions (true/false). |
| - Component ID | Filter by a single component ID. |
| - Component IDs | Comma-separated list of component IDs to filter by. |
| - Component Type | Filter by component type. |
| - Curated RSID | Include curated item status for a given report suite ID. |
| - Dimension | Dimension to run the report against (e.g., "variables/page"). |
| - End Date | End date for filtering (max 3-month period). ISO8601 string format. |
| - Event | Filter logs by event description (exact match, no wildcards). |
| - Event Type | Numeric ID for event type to filter logs. |
| - Expansion | Comma-delimited list to add extra metadata to items. |
| - Favorite | Whether to include only favorite calculated metrics (true/false). |
| - Filter by Date Range | Filter annotations by a specified date range. |
| - Filter by IDs | Filter list by specific IDs. |
| - Filter by Modified After | Filter list to include only items modified after this ISO8601 date. |
| - Filter by Published Segments | Filter segments by published field values ("all", "true", "false"). |
| - Include Type | Include additional annotations not owned by user; options include "all" or "shared". |
| - IP | Filter logs by IP address. |
| - Limit | Maximum number of results to return (minimum 1). Default is 50. |
| - Locale | Locale setting, e.g., "en_US". |
| - Login | Filter logs by user login value. |
| - Lookup None Values | Whether to include none values (true/false). |
| - Migrating | Whether to include migration functions in validation (true/false). |
| - Name | Filter list to include only segments containing this name. |
| - New Definition | Whether to use the new JSON definition format (true/false). |
| - Owner ID | Filter list to include projects owned by the specified login ID. |
| - Page | Page number for pagination (base 0; first page is 0). |
| - Pagination | Whether to return paginated results (true/false). |
| - Reportable | Whether to include only dimensions valid within a report (true/false). |
| - RSID | Report suite ID to filter logs by. |
| - Search And | Space-delimited search terms that will be AND-ed together. |
| - Search Clause | General search string wrapped with single quotes (e.g., 'PageABC'). |
| - Search Not | Search terms to exclude (NOT). |
| - Search Or | Space-delimited search terms that will be OR-ed together. |
| - Search Phrase | Full search phrase to look for. |
| - Segment Filter | Filter list to include only segments in the specified list. |
| - Segmentable | Whether to include only dimensions valid within a segment (true/false). |
| - Sort Direction | Sort direction for results: ASC or DESC. |
| - Sort Property | Property name to sort by (default is "id"). |
| - Start Date | Start date for filtering (max 3-month period). ISO8601 string format. |
| - Tag Names | Filter list to include only segments containing one of these tags. |
| - To Be Used In RSID | Report suite where the calculated metric is intended to be used. |
| - Use Cache | Whether to use caching for faster requests (true/false). |
| - User ID | User ID to return details for (only admins may use this option). |
Output
The node outputs an array of JSON objects representing the calculated metrics retrieved from the Adobe Analytics API. Each object corresponds to a calculated metric and contains its properties as returned by the API, such as metric definitions, IDs, names, approval status, and other metadata.
If the API returns a string response, the node attempts to parse it as JSON; if parsing fails, it outputs the raw string. If no content is returned, the node outputs a status code message indicating "204 No Content".
The node does not output binary data.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n, including:
- Client ID
- Client Secret
- Scope
- The node authenticates using OAuth client credentials flow to obtain an access token before making API requests.
- Network access to
https://ims-na1.adobelogin.comfor token retrieval andhttps://analytics.adobe.io/api/for API calls.
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, the node throws an error "Missing Adobe Analytics API Credentials". Ensure credentials are properly configured.
- Access Token Retrieval Failure: If the node cannot obtain an access token, it throws "Failed to retrieve access token". Verify client ID, secret, and scope are correct.
- Required Parameter Missing: For this operation, the "Global Company ID" is required. Omitting it will cause an error.
- API Errors: Any errors returned by the Adobe Analytics API are caught and rethrown with the message prefix "Error calling Adobe Analytics API". Check the error message and stack trace for details.
- Invalid Query Parameters: Providing invalid or unsupported query parameters may result in empty responses or API errors.
- Pagination Issues: If large result sets are expected, ensure pagination parameters (
page,limit,pagination) are set correctly to avoid missing data.