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 retrieve a list of calculated metric functions. Calculated metric functions are predefined operations or formulas that can be used to create custom metrics within Adobe Analytics, enhancing data analysis capabilities.
Common scenarios for this node include:
- Fetching all available calculated metric functions to understand what operations can be applied when defining new calculated metrics.
- Integrating Adobe Analytics calculated metric functions into automated workflows for reporting or data transformation.
- Validating or exploring metric functions before creating or updating calculated metrics programmatically.
For example, a user might use this node to list all calculated metric functions and then select specific functions to build complex custom metrics in their analytics reports.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the Adobe Analytics company (required). |
| Query Parameters | A collection of optional filters and parameters to refine the list of calculated metric functions. Options include: - Approved (boolean): Include only approved functions. - Classifiable (boolean): Include classifiable dimensions. - Component ID(s) (string): Filter by one or multiple component IDs. - Component Type (string): Filter by component type. - Curated RSID (string): Include curated item status for given RSID. - Dimension (string): Dimension to run the report against. - End Date (string): End date for filtering (max 3 months period). - Event/Event Type/IP/Login/User ID: Various filters for logs. - Expansion (string): Add extra metadata. - Favorite (boolean): Include favorites. - Filter by Date Range/IDs/Modified After/Published Segments: Various filtering options. - Include Type (string): Include additional annotations. - 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 by name. - New Definition (boolean): Use new JSON definition. - Owner ID (string): Filter by owner. - Page (number): Pagination page number. - Pagination (boolean): Enable pagination. - Reportable/Segmentable (boolean): Filter by report/segment validity. - RSID (string): Report suite ID. - Search And/Or/Not/Phrase/Clause (string): Search terms. - Segment Filter (string): Filter segments. - Sort Direction (ASC/DESC), Sort Property (string): Sorting options. - Start Date (string): Start date for filtering. - Tag Names (string): Filter by tags. - To Be Used In RSID (string): Intended report suite. - Use Cache (boolean): Use caching for faster requests. |
Output
The output is an array of JSON objects representing the calculated metric functions retrieved from Adobe Analytics. Each object typically contains details about a single calculated metric function, such as its ID, name, description, and other metadata provided by the Adobe Analytics API.
If the API returns binary data (not typical for this operation), it would represent raw content related to the functions, but this node primarily outputs JSON data.
Dependencies
- Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
- The node authenticates via OAuth2 client credentials grant to obtain an access token.
- Network access to Adobe Analytics API endpoints (
https://analytics.adobe.io/api/...). - Proper permissions on the Adobe Analytics account to list calculated metric functions.
Troubleshooting
- Missing Credentials Error: If the node throws "Missing Adobe Analytics API Credentials," ensure that the Adobe Analytics API credentials are correctly set up in n8n.
- Failed to Retrieve Access Token: This indicates authentication failure; verify client ID, client secret, and scope correctness.
- Required Parameter Missing: For this operation, the
Global Company IDmust be provided; missing it will cause errors. - API Errors: Any error returned by Adobe Analytics API will be wrapped and shown with the message "Error calling Adobe Analytics API." Check the detailed error message and stack trace for specifics.
- Empty or Unexpected Response: Verify query parameters and ensure the Adobe Analytics account has calculated metric functions defined.