Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node integrates with the Adobe Analytics API to perform various operations related to Adobe Analytics components. Specifically, for the Component Meta Data resource and the Share Component with Multiple User operation, it allows users to share one or more components with multiple users at once. This is useful in scenarios where you want to manage access and collaboration on analytics components (such as calculated metrics, segments, or other metadata) across different users within an organization.

Practical examples include:

  • Sharing a dashboard component with a team of analysts.
  • Granting access to specific calculated metrics to multiple users simultaneously.
  • Managing component sharing permissions efficiently without having to share individually per user.

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.
- componentId / componentIds (string): Target component(s).
- componentType (string): Type of component.
- limit (number): Max results.
- page (number): Pagination page.
- sortDirection (ASC/DESC): Sort order.
- And many others for filtering, searching, and controlling response data.
Request Body JSON object containing the details of the share operation, including which components to share and with which users. This is the main payload for the share action.

Output

The node outputs the JSON response from the Adobe Analytics API after attempting to share components with multiple users. The output structure depends on the API response but generally includes confirmation of the share operation, any errors, or status messages.

If the API returns no content (HTTP 204), the node outputs a status message indicating "204 No Content".

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for Adobe Analytics with appropriate permissions.
  • Needs valid Adobe Analytics API credentials including client ID, client secret, and scope.
  • The node performs OAuth2 client credentials flow to obtain an access token before making API calls.
  • Network access to Adobe Analytics API endpoints (https://analytics.adobe.io/ and https://ims-na1.adobelogin.com/ims/token/v3).

Troubleshooting

  • Missing Credentials Error: If the node cannot find the required Adobe Analytics API credentials, it will throw an error. Ensure that the API key credential is configured correctly in n8n.
  • Access Token Retrieval Failure: If the OAuth2 token request fails, verify client ID, client secret, and scope values.
  • Required Parameter Missing: For this operation, if required parameters like component IDs or user information in the request body are missing, the node will throw an error.
  • API Errors: Any API errors returned by Adobe Analytics (e.g., permission denied, invalid component ID) will be surfaced as node errors with descriptive messages.
  • Empty or Unexpected Response: If the API returns an empty string or unexpected format, the node attempts to parse it; failure to parse will return raw text.

Links and References

Discussion