Adobe Analytics icon

Adobe Analytics

Use the Adobe Analytics API
Join our community

Actions57

Overview

This node integrates with the Adobe Analytics API to list date ranges available for a specified company. It allows users to retrieve predefined and custom date ranges that can be used in reports or analytics workflows. This is useful when you want to programmatically access or filter data based on specific time periods defined in Adobe Analytics.

Common scenarios include:

  • Automating report generation by selecting relevant date ranges.
  • Synchronizing date range metadata with other systems.
  • Filtering analytics data dynamically based on user-defined or standard date ranges.

For example, you might use this node to fetch all date ranges for your company and then loop through them to generate reports for each period automatically.

Properties

Name Meaning
Global Company ID The unique identifier of the Adobe Analytics company (or global company) for which the date ranges are requested.
Query Parameters A collection of optional filters and parameters to refine the list of date ranges returned. These include:
- Approved: Whether to include only approved calculated metrics (boolean).
- Classifiable: Whether to include classifiable dimensions (boolean).
- Component ID / Component IDs: Filter by one or multiple component IDs (string).
- Component Type: Filter by component type (string).
- Curated RSID: Include curated item status for a given report suite ID (string).
- Dimension: Dimension to run the report against (string).
- End Date / Start Date: Define the date range boundaries (ISO8601 string).
- Event / Event Type: Filter logs by event description or numeric event type ID (string).
- Expansion: Add extra metadata fields (comma-delimited string).
- Favorite: Whether to include favorite calculated metrics (boolean).
- Filter by Date Range / IDs / Modified After / Published Segments: Various filtering options (string).
- Include Type: Include additional annotations not owned by the user; options like "all" or "shared" (string).
- IP / Login / User ID: Filters related to user or IP address (string or number).
- Limit: Maximum number of results to return (number).
- Locale: Locale setting, e.g., "en_US" (string).
- Lookup None Values, Migrating, New Definition, Reportable, Segmentable, Use Cache: Boolean flags controlling inclusion and behavior of returned data.
- Name, Search And/Or/Not/Phrase, Search Clause: Various search filters (string).
- Page, Pagination: Controls pagination of results (number and boolean).
- Sort Direction & Sort Property: Controls sorting order and property (ASC/DESC and string).
- Tag Names, Segment Filter, To Be Used In RSID, Owner ID: Additional filtering parameters (string).

Note: Most query parameters are optional and allow fine-tuning the request to get exactly the date ranges needed.

Output

The node outputs an array of JSON objects representing the date ranges retrieved from Adobe Analytics. Each object corresponds to a date range entity with its properties as returned by the Adobe Analytics API.

The exact structure depends on the API response but typically includes identifiers, names, start and end dates, and metadata about each date range.

No binary data output is produced by this node.

Dependencies

  • Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
  • The node authenticates using OAuth client credentials flow to obtain an access token.
  • Network access to https://ims-na1.adobelogin.com for authentication and https://analytics.adobe.io/api/{globalCompanyId} for API requests.

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 obtain an access token from Adobe's IMS service will cause the node to error out. Check client ID, secret, and network connectivity.
  • Required Parameter Missing: For operations requiring IDs (e.g., dateRangesId), if these are not provided, the node throws an error specifying the missing parameter.
  • API Errors: Any errors returned by the Adobe Analytics API are wrapped and reported with details. Common issues include invalid parameters, permission issues, or rate limits.
  • Empty or Unexpected Response: If the API returns no content or unexpected data, verify the query parameters and company ID correctness.

Links and References

Discussion