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 interacts with the Adobe Analytics API to retrieve, create, update, delete, and manage various Adobe Analytics resources. Specifically for the Segment resource with the Get Segment operation, it fetches detailed information about a single segment identified by its Segment ID within a specified global company context.
Use cases include:
- Retrieving metadata and configuration details of a specific segment used in Adobe Analytics reports.
- Automating workflows that require segment data for further processing or reporting.
- Integrating segment information into broader analytics or marketing automation pipelines.
Example: You want to get the definition and properties of a particular segment by its ID to analyze user behavior patterns segmented by that criteria.
Properties
| Name | Meaning |
|---|---|
| Global Company ID | The unique identifier of the Adobe Analytics company (or organization) under which the segment exists. This is required to scope the API request correctly. |
| Segment ID | The unique identifier of the segment you want to retrieve. Required for the Get Segment operation to specify which segment's details to fetch. |
| Query Parameters | Optional additional parameters to refine or filter the request. These include many options such as: • Approved (boolean): Include only approved calculated metrics. • Classifiable (boolean): Include classifiable dimensions. • Component ID(s), Type, Curated RSID, Dimension, Event filters, Date ranges (startDate, endDate), Pagination controls (page, limit), Sorting options (sortProperty, sortDirection), Locale, and many others. These parameters allow fine-tuning the returned data or filtering related metadata. |
Note: For the Get Segment operation, the main required inputs are the Global Company ID and the Segment ID. Other query parameters may be ignored or not applicable depending on the API endpoint.
Output
The output is a JSON object representing the retrieved segment's details. This typically includes:
- Segment metadata such as name, description, owner, creation/modification dates.
- Segment definition including rules, filters, and conditions that define the segment.
- Additional attributes or flags related to the segment's status, usage, and sharing.
If the API returns no content, the node outputs a status code message indicating "204 No Content".
The node does not output binary data for this operation.
Dependencies
- Requires an API key credential for Adobe Analytics API authentication.
- Uses OAuth client credentials flow to obtain an access token from Adobe Identity Management System.
- Requires network access to
https://ims-na1.adobelogin.com/ims/token/v3for token retrieval andhttps://analytics.adobe.io/api/{globalCompanyId}/segments/{segmentId}for the segment data. - The node expects the user to configure the Adobe Analytics API credentials in n8n before use.
Troubleshooting
- Missing Credentials Error: If the Adobe Analytics API credentials are not set or invalid, the node will throw an error "Missing Adobe Analytics API Credentials". Ensure credentials are configured properly.
- Failed to Retrieve Access Token: If the OAuth token request fails, the node throws "Failed to retrieve access token". Check client ID, client secret, and scope values in credentials.
- Required Parameter Missing: If the Segment ID or Global Company ID is empty when required, the node throws an error indicating the missing parameter. Provide valid IDs.
- API Errors: Any HTTP or API errors are wrapped and reported with the message prefix "Error calling Adobe Analytics API" along with the original error message and stack trace if available.
- Empty or Unexpected Response: If the API returns an empty string or unexpected format, the node attempts to parse JSON; if parsing fails, it returns raw text or a 204 status message.
Links and References
This summary focuses on the Segment - Get Segment operation extracted from the bundled source code and provided property definitions.