Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API

Overview

This node interacts with the Adobe Analytics API to retrieve detailed usage and access logs. Specifically, the "List Usage Logs" operation under the "Usage Log" resource fetches audit logs based on various search criteria. This is useful for monitoring API usage, auditing user actions, and tracking events within an Adobe Analytics environment.

Practical scenarios include:

  • Auditing who accessed or modified analytics components.
  • Monitoring API usage patterns for compliance or troubleshooting.
  • Filtering logs by date range, event type, user, IP address, or other metadata to analyze specific activities.

Properties

Name Meaning
Global Company ID The unique identifier of the company in Adobe Analytics context. Required to specify which company's data to query.
Query Parameters A collection of optional filters and parameters to refine the usage log search. These include:
- Approved (boolean): Include only approved calculated metrics.
- Classifiable (boolean): Include classifiable dimensions.
- Component ID / Component IDs (string): Filter logs by specific component(s) IDs.
- Component Type (string): Filter by component type.
- Curated RSID (string): Include curated item status for a given report suite ID.
- Dimension (string): Run report against a specific dimension (e.g., "variables/page").
- End Date / Start Date (string): Define the date range for logs (max 3 months).
- Event / Event Type (string): Filter logs by event description or numeric event type ID.
- Expansion (string): Add extra metadata fields (comma-separated).
- Favorite (boolean): Include favorite calculated metrics.
- Filter by Date Range / IDs / Modified After / Published Segments (string): Various filtering options for annotations, segments, or modification dates.
- Include Type (string): Include additional annotations not owned by the user ("all", "shared").
- IP (string): Filter logs by IP address.
- Limit (number): Maximum number of results to return (minimum 1, default 50).
- Locale (string): Locale setting, e.g., "en_US".
- Login (string): Filter logs by user login value.
- Lookup None Values (boolean): Whether to include entries with none values.
- Migrating (boolean): Include migration functions in validation.
- Name (string): Filter segments containing this name.
- New Definition (boolean): Use new JSON definition format.
- Owner ID (string): Filter projects owned by specified login ID.
- Page (number): Pagination page number (base 0).
- Pagination (boolean): Whether to paginate results.
- Reportable (boolean): Include only dimensions valid within a report.
- RSID (string): Filter logs by report suite ID.
- Search And / Or / Not / Clause / Phrase (string): Various search term filters combined with logical operators.
- Segment Filter (string): Filter segments by list.
- Segmentable (boolean): Include only dimensions valid within a segment.
- Sort Direction (options): Sort order, either ASC or DESC.
- Sort Property (string): Property to sort by (default "id").
- Tag Names (string): Filter segments containing one or more tags.
- To Be Used In RSID (string): Report suite where the calculated metric is intended to be used.
- Use Cache (boolean): Use caching for faster requests.
- User ID (number): Filter logs by user ID (admin only).

Output

The output is a JSON array where each element corresponds to a usage log entry retrieved from the Adobe Analytics API. Each entry contains detailed information about API usage or access events matching the specified filters.

If the API returns no content, the node outputs a JSON object indicating "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 obtains an OAuth2 access token via Adobe's IMS token endpoint before making API calls.
  • Network connectivity to https://analytics.adobe.io and https://ims-na1.adobelogin.com is required.

Troubleshooting

  • Missing Credentials: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials".
  • Access Token Retrieval Failure: Failure to obtain an access token results in "Failed to retrieve access token". Check client ID, secret, and scope correctness.
  • Required Parameter Missing: For this operation, the "Global Company ID" is mandatory. Omitting it will cause an error.
  • API Errors: Any errors returned by the Adobe Analytics API are wrapped and reported as "Error calling Adobe Analytics API" with details.
  • Empty Response: If no logs match the criteria, the node returns a "204 No Content" status in JSON form.
  • Invalid Query Parameters: Providing unsupported or malformed query parameters may result in API errors; ensure parameters conform to expected types and formats.

Links and References

Discussion