Actions57
- Annotation Actions
- Calculated Metric Actions
- Component Meta Data Actions
- Add Tags
- Delete Multiple Tags
- Delete One Tag
- Delete Shared Component
- Get Shared Component
- Get Tag
- List Shared Components by the User
- List Shared Components to the User
- List Tag Names
- List Tags
- Save Tags
- Search Shared Components
- Search Tags for Multiple Components
- Search Tags for One Component
- Share Component with Multiple User
- Share Component with One User
- Date Range Actions
- Dimension Actions
- Metric Actions
- Project Actions
- Report Actions
- Segment Actions
- Usage Log Actions
- User Actions
Overview
This node integrates with the Adobe Analytics API to perform various operations related to analytics data management. Specifically, the "Segment" resource with the "List Segments" operation allows users to retrieve a list of segments defined in their Adobe Analytics account. Segments are subsets of data that help refine analysis by filtering or grouping visitors based on specific criteria.
Common scenarios for this node include:
- Fetching all available segments to display or use in further reporting workflows.
- Filtering segments by name, tags, ownership, or other metadata to find relevant segments quickly.
- Paginating through large sets of segments when managing many segment definitions.
Practical example:
- A marketing analyst wants to automate the retrieval of all customer segments tagged as "VIP" to feed into a campaign targeting workflow.
- A data engineer needs to list segments filtered by creation date or owner to audit segment usage across teams.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier for the Adobe Analytics company (or organization) under which the segments exist. Required for API calls. |
| Query Parameters | A collection of optional filters and parameters to customize the segment listing request. These include: |
| - Approved: Include only approved calculated metrics (boolean). | |
| - Classifiable: Include classifiable dimensions (boolean). | |
| - Component ID(s): 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: Run report against a specific dimension (string). | |
| - End Date / Start Date: Define a date range for filtering (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: Include favorite calculated metrics (boolean). | |
| - Filter by Date Range / IDs / Modified After / Published Segments: Various filters to narrow results (strings). | |
| - Include Type: Include annotations not owned by user ("all", "shared") (string). | |
| - IP / Login / User ID: Filters based on user or IP address (string/number). | |
| - Limit: Maximum number of results to return (number, minimum 1). | |
| - Locale: Locale setting for returned data (string, e.g., "en_US"). | |
| - Lookup None Values, Migrating, New Definition, Reportable, Segmentable, Use Cache: Boolean flags controlling inclusion/exclusion of certain data types or caching behavior. | |
| - Name / Tag Names / Owner ID / Segment Filter: Filters to include segments by name, tags, owner, or specific segment lists (string). | |
| - Page / Pagination: Controls pagination of results (page number starting at 0, boolean to enable pagination). | |
| - Search And / Or / Not / Clause / Phrase: Complex search terms to filter segments (strings). | |
| - Sort Direction / Sort Property: Sorting options for the result set (ASC/DESC, property name). | |
| - To Be Used In RSID: Filter segments intended for use in a specific report suite ID (string). |
Output
The output is a JSON array where each element represents a segment object retrieved from Adobe Analytics. Each segment object contains metadata and details about the segment such as its ID, name, definition, owner, tags, and other attributes depending on the query parameters used.
If the API returns no content, the node outputs a status message indicating "204 No Content".
No binary data output is produced by this operation.
Dependencies
- Requires an Adobe Analytics API credential configured in n8n with client ID, client secret, and scope.
- The node obtains an OAuth access token via Adobe's IMS token endpoint before making API requests.
- Network connectivity to Adobe Analytics API endpoints is required.
Troubleshooting
- Missing Credentials: If the Adobe Analytics API credentials are not provided 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 some operations, missing required IDs (e.g., Segment ID) will cause errors like "Segment ID is required".
- API Errors: Any HTTP or API errors are wrapped and reported with messages prefixed by "Error calling Adobe Analytics API".
- Empty Response: If no segments match the query, the node returns a "204 No Content" status message.
- Pagination Issues: Ensure correct page numbering (starting at 0) and limit values to avoid unexpected empty results.