Get A Segment Users - Captain icon

Get A Segment Users - Captain

Node to get the users of a segment

Get A Segment Users - Captain

AI-generated

Overview

This node retrieves users belonging to a specified segment from a customer data platform (CDP). It allows users to select a predefined segment or define a custom segmentation rule, and optionally include the latest events associated with each user. This is useful for marketing automation, customer analysis, or targeted campaigns where segment-specific user data is required.

Use Case Examples

  1. A marketing team wants to fetch all users in a 'High-Value Customers' segment to send a personalized promotion.
  2. An analyst needs to retrieve users who meet a custom segmentation rule based on recent activity and demographic filters.
  3. A campaign manager wants to attach the latest user events to segment users for behavior-based targeting.

Properties

Name Meaning
Select A Segment Choose a predefined segment from the list or opt to use a custom segmentation rule.
Segment Filtering Rule Define a custom JSON-based segmentation rule to filter users manually or with AI assistance.
Include Latest Events Select zero or more event names to attach the latest occurrences of these events to each returned user.

Output

JSON

  • ``
    • user - User data object for each user in the segment.

Dependencies

  • Requires environment variables CDP_URL and UNEXO_API_KEY for API endpoint and authentication.

Troubleshooting

  • Common issues include API request failures due to incorrect or missing environment variables (CDP_URL, UNEXO_API_KEY).
  • Network errors or server unavailability may cause retries and eventual failure after 3 attempts.
  • Invalid JSON in the Segment Filtering Rule may cause the API to reject the request.

Discussion