Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node interacts with the Adobe Analytics API to search for tags associated with a single component within the "Component Meta Data" resource. It allows users to retrieve metadata tags linked to a specific component by specifying its ID and type, among other optional query parameters. This is useful in scenarios where you want to manage or analyze metadata tags related to components such as dimensions, metrics, or segments in Adobe Analytics.

Practical examples include:

  • Fetching all tags assigned to a particular dashboard component.
  • Retrieving tags for a specific calculated metric or segment to understand its categorization.
  • Filtering tags based on various criteria like approval status, date ranges, or component types.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics context. Required for API calls.
Query Parameters A collection of optional filters and settings to refine the tag search. Options include:
- Approved Whether to include only approved calculated metrics (true/false).
- Classifiable Whether to include classifiable dimensions (true/false).
- Component ID The specific component ID to operate on (string).
- Component IDs Comma-separated list of component IDs to operate on (string).
- Component Type The type of component to return (string).
- Curated RSID Include curated item status for a given report suite ID (string).
- Dimension Dimension to run the report against (e.g., "variables/page") (string).
- End Date End date for filtering data, max 3 months period (ISO8601 string).
- Event Filter logs by event description (no wildcards) (string).
- Event Type Numeric ID for event type filter (string).
- Expansion Extra metadata to add to items (comma-delimited string).
- Favorite Whether to include favorite calculated metrics (true/false).
- Filter by Date Range Filter annotations by specified date range (string).
- Filter by IDs Filter list by specific IDs (string).
- Filter by Modified After Filter annotations modified since this date (ISO8601 string).
- Filter by Published Segments Filter segments by published field values ("all", "true", "false") (string).
- Include Type Include additional annotations not owned by user; options include "all" or "shared" (string).
- IP Filter logs by IP address (string).
- Limit Maximum number of results to return (number, min 1).
- Locale Locale setting, default "en_US" (string).
- Login Filter logs by user login value (string).
- Lookup None Values Whether to include none values (true/false).
- Migrating Whether to include migration functions in validation (true/false).
- Name Filter segments containing this name (string).
- New Definition Whether to use the new JSON definition format (true/false).
- Owner ID Filter projects owned by specified login ID (string).
- Page Pagination page number (base 0) (number).
- Pagination Whether to return paginated results (true/false).
- Reportable Include only dimensions valid within a report (true/false).
- RSID Report suite ID to filter logs by (string).
- Search And Search terms AND-ed together (space delimited string).
- Search Clause General search string wrapped with single quotes (string).
- Search Not Search terms to exclude (string).
- Search Or Search terms OR-ed together (space delimited string).
- Search Phrase Full search phrase (string).
- Segment Filter Filter segments included in specified list (string).
- Segmentable Include only dimensions valid within a segment (true/false).
- Sort Direction Sort order: ASC or DESC.
- Sort Property Property to sort by (string), default "id".
- Start Date Start date for filtering, max 3 months period (ISO8601 string).
- Tag Names Filter segments containing one of these tags (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 (true/false).
- User ID User ID to return details for (only admins may use) (number).

Output

The node outputs an array of JSON objects representing the tags associated with the specified component(s). Each object contains metadata about a tag, such as its ID, name, and any other relevant properties returned by the Adobe Analytics API.

If the response is empty or no content is returned, the output will indicate a "204 No Content" status.

No binary data output is involved in this operation.

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
  • The node makes authenticated HTTP requests to the Adobe Analytics API endpoints.
  • Network access to https://ims-na1.adobelogin.com for token retrieval and https://analytics.adobe.io/api/ for API calls is required.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Access Token Retrieval Failure: Failure to obtain an access token from Adobe IMS will result in an error. Check client ID, client secret, and scope correctness.
  • Required Parameter Missing: For this operation, if the component ID or component type is missing, the node may fail or return incomplete data.
  • API Errors: Any errors returned by the Adobe Analytics API will be surfaced as node errors with messages prefixed by "Error calling Adobe Analytics API".
  • Pagination Issues: If large result sets are expected, ensure pagination parameters (page, limit, pagination) are correctly set to avoid incomplete data.
  • Date Format: Dates must be in ISO8601 format; incorrect formats may cause API errors.

Links and References

Discussion