Segment Details
AI-generatedOverview
This node interacts with Braze user segments, allowing users to manage and retrieve analytics data related to these segments. It supports operations such as fetching time-series analytics for segment sizes, obtaining detailed information about specific segments, and listing all available segments for filtering purposes.
Common scenarios where this node is beneficial include:
- Marketing teams analyzing user engagement trends over time by segment.
- Product managers retrieving detailed metadata about user segments to tailor campaigns.
- Data analysts compiling lists of segments to filter or segment user data in reports.
For example, a user might use the "Segment Details" operation to get comprehensive information about a particular user segment identified by its Segment ID, enabling targeted messaging strategies.
Properties
| Name | Meaning |
|---|---|
| Segment ID | The unique API identifier of the Braze user segment to retrieve details for. |
Note: The "Segment ID" property is required when performing the "Segment Details" operation.
Output
The node outputs JSON data corresponding to the selected operation:
For Segment Details, the output JSON contains detailed information about the specified user segment, including metadata and configuration details as returned by the Braze API.
For other operations (not requested here), the output would include either time-series analytics data or lists of segments.
The output is structured as an array of items, each with a json field containing the API response data. If errors occur and the node is configured to continue on failure, error details are included in the output JSON under an error field along with HTTP status codes and Braze-specific error codes.
No binary data output is produced by this node.
Dependencies
- Requires an active Braze API connection authenticated via an API key credential.
- Needs the Braze instance URL or endpoint to construct API requests.
- Uses HTTP GET requests to Braze's REST API endpoints for segments.
Troubleshooting
Common issues:
- Invalid or missing Segment ID will cause API errors.
- Incorrect or expired API key credentials will result in authentication failures.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Errors returned from the Braze API are captured and surfaced in the node output if "Continue On Fail" is enabled.
- Typical error messages include authorization failures, invalid parameters, or resource not found.
Resolution tips:
- Verify that the Segment ID is correct and exists in your Braze account.
- Ensure the API key credential is valid and has sufficient permissions.
- Check network connectivity and Braze service status.