Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to perform various operations related to Adobe Analytics components. Specifically, the "Share Component with One User" operation under the "Component Meta Data" resource allows sharing a single component (such as a dimension, metric, or segment metadata) with one user. This is useful in scenarios where you want to grant access or collaboration rights on specific analytics components to individual users within your organization.

Practical examples include:

  • Sharing a custom calculated metric or segment with a colleague for collaborative analysis.
  • Granting access to a particular metadata component to a new team member without sharing it broadly.
  • Managing component permissions programmatically as part of an automated workflow.

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 parameters to filter or modify the request. Includes many options such as:
- Approved (boolean): Include only approved metrics.
- Component ID(s) (string): Target component(s) IDs.
- Component Type (string): Type of component.
- Limit (number): Max number of results.
- Locale (string): Language/locale setting.
...and many others for filtering, sorting, pagination, and metadata expansion.
Request Body JSON object containing the details of the share operation, typically specifying the user and component information to share.

Note: For the "Share Component with One User" operation, the key inputs are the Global Company ID, relevant Query Parameters (especially component identifiers), and the Request Body which contains the share details.

Output

The node outputs the response from the Adobe Analytics API call as JSON. The structure depends on the API endpoint but generally includes confirmation of the share action, details about the shared component, or error messages if the operation failed.

If the API returns no content (HTTP 204), the output will indicate "Status Code": "204 No Content".

No binary data output is expected from this operation.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n that provides:
    • Client ID
    • Client Secret
    • Scope for authentication
  • The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
  • Network access to Adobe's IMS token service (https://ims-na1.adobelogin.com/ims/token/v3) and Adobe Analytics API endpoints (https://analytics.adobe.io/api/...).

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, 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, secret, and network connectivity.
  • Required Parameter Missing: For this operation, if required parameters like Global Company ID or component identifiers are missing, the node throws an error specifying the missing field.
  • API Errors: Any errors returned by the Adobe Analytics API (e.g., permission denied, invalid component ID) will be surfaced as node errors with descriptive messages.
  • Invalid JSON in Request Body: The Request Body must be valid JSON; otherwise, parsing errors may occur.
  • Rate Limits or Quotas: Adobe Analytics API may enforce rate limits; hitting these can cause errors or throttling.

To resolve issues:

  • Verify all required input properties are provided.
  • Ensure credentials are correctly configured and valid.
  • Validate the JSON structure in the request body.
  • Review API documentation for correct usage of query parameters and request payloads.
  • Check network connectivity and proxy settings if applicable.

Links and References

Discussion