Braze SegmentsInstall

Overview

This node interacts with Braze's user segmentation API to manage and retrieve analytics about user segments. It supports operations such as listing all available segments, fetching detailed information about specific segments, and obtaining time-series analytics on segment sizes.

Common scenarios for this node include:

• Retrieving a paginated list of user segments to filter or analyze user groups.
• Getting detailed metadata about a particular segment for targeted marketing or analysis.
• Fetching historical size data of a segment over time to understand user engagement trends.

For example, a marketer might use the "Segment List" operation to get all segments and then select one to analyze its growth using "Segment Analytics."

Properties

Output

The node outputs JSON data corresponding to the selected operation:

• Segment List: Returns a JSON object containing a list of segments, potentially paginated according to the Page parameter, sorted by creation date based on Sort Direction.
• Segment Details: Returns detailed JSON information about a specific segment identified by its ID.
• Segment Analytics: Returns time-series JSON data representing the size of a segment over a specified period.

If an error occurs during the API request, the output JSON will contain error details including the error message, HTTP code, and Braze-specific error code.

The node does not output binary data.

Dependencies

• Requires an API key credential for authenticating with the Braze API.
• Needs the Braze instance URL or identifier to construct the correct API endpoint.
• The node uses HTTP GET requests to Braze's REST API endpoints for segments.

Troubleshooting

• Common issues:

  • Invalid or missing API key can cause authentication failures.
  • Requesting a non-existent segment ID will result in errors from the Braze API.
  • Pagination parameters out of range may return empty results or errors.

• Error messages:

  • Errors returned from Braze are captured and included in the output JSON under an error field.
  • HTTP status codes and Braze error codes are also provided to help diagnose issues.

• Resolution tips:

  • Verify that the API key is valid and has sufficient permissions.
  • Ensure segment IDs used in parameters exist in your Braze account.
  • Adjust pagination parameters within valid ranges.
  • Use the error details in the output to identify and fix issues.

Links and References

• Braze API Documentation - Segments
• Braze Developer Portal