Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

The "List Tag Names" operation under the "Component Meta Data" resource in this Adobe Analytics node retrieves component IDs associated with specified tag names. This is useful for users who want to filter or identify components (such as dimensions, metrics, or segments) by their tags within an Adobe Analytics environment.

Typical use cases include:

  • Fetching all components tagged with certain keywords to organize or analyze them.
  • Automating workflows that depend on metadata tagging for reporting or data management.
  • Integrating tag-based filtering into larger analytics automation pipelines.

For example, a user might want to list all components tagged with "marketing" and "Q2" to generate reports only for those relevant components.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics context. Required to specify the scope of the API call.
Query Parameters A collection of optional filters and parameters to refine the request. For "List Tag Names", these can include:
- Approved Whether to include only approved calculated metrics (true/false).
- Classifiable Whether to include classifiable dimensions (true/false).
- Component ID Specific component ID to operate on.
- Component IDs Comma-separated list of component IDs to operate on.
- Component Type Filter by component type to return.
- 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 the query period (ISO8601 format).
- Event Event description to filter logs by (no wildcards).
- Event Type Numeric ID for event type to filter logs by.
- Expansion Extra metadata to add to items (comma-delimited list).
- Favorite Whether to include favorite calculated metrics (true/false).
- Filter by Date Range Filter annotations by a specific date range.
- Filter by IDs Filter list by specific IDs.
- Filter by Modified After Filter list to include only items modified after a certain date (ISO8601).
- Filter by Published Segments Filter segments by published field values ("all", "true", "false").
- Include Type Include additional annotations not owned by the user; options include "all" or "shared".
- IP IP address to filter logs by.
- Limit Maximum number of results to return (minimum 1). Default is 50.
- Locale Locale string, e.g., "en_US".
- Login User login value to filter logs by.
- 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 (true/false).
- Owner ID Filter list to include projects owned by the specified login ID.
- Page Page number for pagination (base 0). Default is 0.
- Pagination Whether to return paginated results (true/false). Default is true.
- Reportable Whether to include only dimensions valid within a report (true/false).
- RSID Report suite ID to filter logs by.
- Search And Search terms AND-ed together (space delimited).
- Search Clause General search string wrapped with single quotes.
- Search Not Search terms to exclude.
- Search Or Search terms OR-ed together (space delimited).
- 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, either "ASC" or "DESC". Default is "ASC".
- Sort Property Property to sort by. Default is "id".
- Start Date Start date for the query period (ISO8601 format).
- Tag Names Filter list to include only segments that contain one of these tags (comma-separated string).
- 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). Default is true.
- User ID User ID to return details for (only admins may use this option).

Output

The output is a JSON array where each element corresponds to the response from the Adobe Analytics API for the requested tag names. The structure typically includes component IDs associated with the specified tags and possibly additional metadata depending on the query parameters.

If the API returns binary data (not typical for this operation), it would represent raw content related to the components or tags, but this operation primarily deals with JSON metadata.

Example output snippet (conceptual):

[
  {
    "tagName": "marketing",
    "componentIds": ["comp123", "comp456", "comp789"]
  },
  {
    "tagName": "Q2",
    "componentIds": ["comp234", "comp567"]
  }
]

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and appropriate scopes.
  • The node makes authenticated HTTP requests to Adobe's IMS token service to obtain an access token.
  • Subsequent API calls are made to the Adobe Analytics API endpoint using the acquired token.
  • Proper configuration of the Adobe Analytics API credentials in n8n is necessary.

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 get an access token from Adobe IMS will result in an error. Check client ID, client secret, and scope correctness.
  • Required Parameter Missing: If required parameters like Global Company ID or Tag Names are missing, the node will throw an error specifying which parameter is required.
  • API Errors: Any errors returned by the Adobe Analytics API (e.g., invalid tag names, permission issues) will be surfaced as node errors with descriptive messages.
  • Pagination Issues: If large result sets are expected, ensure pagination parameters are correctly set to avoid incomplete data.
  • Date Format: Ensure date parameters follow ISO8601 format to prevent API rejections.

Links and References

Discussion