Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to manage and retrieve user-related data within an Adobe Analytics company account. Specifically, the "List Users" operation fetches a list of users associated with the current user's company login. This is useful for scenarios where you need to automate user management tasks, audit user access, or synchronize user information from Adobe Analytics into other systems.

Practical examples include:

  • Automatically retrieving all users in your Adobe Analytics company to generate reports or notifications.
  • Integrating user lists into internal dashboards or CRM systems.
  • Auditing user access and permissions programmatically.

Properties

Name Meaning
Global Company ID The unique identifier of the Adobe Analytics company (tenant) whose users you want to list. Required for scoping the API request.
Query Parameters A collection of optional filters and parameters to refine the user list query. These include:
- Approved (boolean): Include only approved calculated metrics.
- Classifiable (boolean): Include classifiable dimensions.
- Component ID(s) (string): Filter by component IDs.
- Component Type (string): Filter by component type.
- Curated RSID (string): Include curated item status.
- Dimension (string): Dimension filter.
- End Date (string): End date for filtering.
- 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 filters.
- Include Type (string): Include additional annotations.
- IP (string): Filter by IP address.
- Limit (number): Max number of results.
- Locale (string): Locale setting.
- Login (string): Filter by user login.
- Lookup None Values (boolean): Include none values.
- Migrating (boolean): Include migration functions.
- Name (string): Filter by segment name.
- New Definition (boolean): Use new JSON definition.
- Owner ID (string): Filter by project owner.
- Page (number): Pagination page number.
- Pagination (boolean): Enable pagination.
- Reportable (boolean): Include report-valid dimensions.
- RSID (string): Report suite ID.
- Search And/Or/Not/Phrase/Clause (string): Search terms.
- Segment Filter/Segmentable (string/boolean): Segment filters.
- Sort Direction (ASC/DESC): Sorting order.
- Sort Property (string): Property to sort by.
- Start Date (string): Start date for filtering.
- Tag Names (string): Filter by tags.
- To Be Used In RSID (string): Target report suite.
- Use Cache (boolean): Use caching.
- User ID (number): Specific user ID (admin only).

Note: Many of these query parameters are generic filters applicable across multiple resource types; for listing users, relevant filters would typically be those related to user identification such as login, userid, limit, page, and pagination.

Output

The output is a JSON array where each element represents a user object retrieved from the Adobe Analytics API. Each user object contains details about a user in the company, such as their ID, login, roles, and other metadata provided by the API.

If the API returns no content, the node outputs a JSON object indicating "Status Code": "204 No Content".

No binary data output is produced by this operation.

Dependencies

  • Requires an Adobe Analytics API credential with client ID, client secret, and scope configured in n8n.
  • The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
  • Network access to Adobe's IMS token endpoint (https://ims-na1.adobelogin.com/ims/token/v3) and Adobe Analytics API endpoints (https://analytics.adobe.io/api/{globalCompanyId}/users) is required.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or incomplete, the node will throw an error "Missing Adobe Analytics API Credentials". Ensure that the API key credential is properly configured.
  • Access Token Retrieval Failure: If the node cannot obtain an access token, it throws "Failed to retrieve access token". Verify client ID, client secret, and scope correctness.
  • Required Parameter Missing: For some operations, if required parameters like Global Company ID or User ID (for admin-only queries) are missing, the node will throw errors indicating which parameter is required.
  • API Errors: Any API call failure will result in an error message prefixed with "Error calling Adobe Analytics API:" followed by the specific error message. Check network connectivity, API limits, and permissions.
  • Empty Response: If the API returns no users, the node outputs a status code 204 message. Confirm that the query parameters are correct and that users exist in the specified company.

Links and References

This summary focuses on the "User" resource and the "List Users" operation, describing how the node constructs the API request, handles authentication, and processes the response accordingly.

Discussion