Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node interacts with the Adobe Analytics API to list tags associated with components in a user's company. Specifically, the "List Tags" operation under the "Component Meta Data" resource retrieves all tags available for the current user’s company. This is useful for managing and organizing metadata tags that categorize or describe various analytics components such as dimensions, metrics, or segments.

Common scenarios include:

  • Fetching all tags to display in a UI for selection or filtering.
  • Synchronizing tag lists between Adobe Analytics and other systems.
  • Auditing or reporting on tags used within an organization.

Example: A marketing analyst wants to retrieve all tags applied to components in their Adobe Analytics account to understand how data elements are categorized before building reports.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics context. Required to scope the API request to the correct company.
Query Parameters A collection of optional filters and parameters to refine the tag listing. Options include:
- Approved (boolean): Include only approved calculated metrics.
- 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): Run report against specific dimension.
- End Date / Start Date (string): Date range filters.
- Event / Event Type (string): Filter logs by event description or type.
- Expansion (string): Add extra metadata.
- Favorite (boolean): Include favorite calculated metrics.
- Filter by Date Range / IDs / Modified After / Published Segments (string): Various filtering options.
- Include Type (string): Include additional annotations not owned by user ("all", "shared").
- IP, Login, User ID (string/number): Filters based on user or IP.
- Limit (number): Max number of results.
- Locale (string): Locale setting.
- Lookup None Values, Migrating, New Definition, Pagination, Reportable, Segmentable, Use Cache (boolean): Various flags controlling response.
- Name, Search And/Or/Not/Phrase, Search Clause (string): Search terms.
- Segment Filter, Tag Names, To Be Used In RSID, Owner ID (string): Additional filters.
- Page (number): Pagination page number.
- Sort Direction (ASC/DESC), Sort Property (string): Sorting options.

Note: The full list of query parameters is extensive and allows fine-grained control over which tags and related metadata are returned.

Output

The output is a JSON array where each element represents a tag object associated with the user's company components. Each tag object typically includes details such as tag ID, name, and possibly associated metadata depending on the query parameters used.

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

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and appropriate scopes.
  • The node performs OAuth2 client credentials flow to obtain an access token from Adobe IMS.
  • Network access to https://ims-na1.adobelogin.com for authentication and https://analytics.adobe.io/api/{globalCompanyId} for API calls.
  • Proper configuration of the Adobe Analytics API credential 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 cause the node to error out. Check client ID, client secret, and scope correctness.
  • Required Parameter Missing: For this operation, the "Global Company ID" must be provided; otherwise, the node throws an error.
  • API Errors: Any errors returned by the Adobe Analytics API (e.g., invalid parameters, permission issues) will be surfaced as node errors with messages prefixed by "Error calling Adobe Analytics API".
  • Empty or Unexpected Response: If the API returns no content or unexpected data, the node attempts to parse and return it gracefully, but malformed responses may cause parsing errors.

To resolve these issues:

  • Verify credentials and permissions.
  • Ensure required parameters are set.
  • Review API limits and usage quotas.
  • Check network connectivity.

Links and References

Discussion