Braze SegmentsInstall

Overview

This node interacts with Braze user segments, allowing users to manage and retrieve analytics data about these segments. It is particularly useful for marketing automation, customer segmentation analysis, and campaign targeting scenarios where understanding segment size trends or details is important.

The "Segment Analytics" operation fetches time-series data on segment sizes over a specified number of days, optionally ending at a given date. This helps track how a segment's population changes over time.

Practical examples:

• A marketer wants to see how a user segment has grown or shrunk over the past two weeks.
• An analyst needs detailed information about a specific segment to understand its composition.
• A campaign manager retrieves a list of all available segments to filter and target users effectively.

Properties

Output

The node outputs JSON data corresponding to the selected operation:

• Segment Analytics: Returns a time-series dataset representing the size of the specified segment over the requested period. The structure includes dates and segment size counts.
• Segment Details: Provides detailed metadata about a specific segment.
• Segment List: Outputs a list of all segments available for filtering and analytics.

If an error occurs during the API request, the output JSON will contain an error field describing the issue, along with additional error metadata.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the Braze API.
• Needs the Braze instance URL or endpoint configured as part of the credentials.
• The node makes HTTP GET requests to Braze API endpoints to fetch segment data.

Troubleshooting

• Common issues:

  • Invalid or missing API key credential will cause authentication failures.
  • Providing an incorrect or non-existent Segment ID will result in errors from the Braze API.
  • Specifying an invalid date format for "Ending At" may cause request failures.
  • Requesting a length outside the allowed range (1-100) might lead to validation errors.

• Error messages:

  • Errors returned from the Braze API are captured and included in the output JSON under the error field.
  • HTTP status codes and Braze-specific error codes are also provided to help diagnose issues.
  • To resolve errors, verify API credentials, ensure correct segment IDs, and validate input parameters.

• The node supports continuing execution on failure if enabled, allowing workflows to handle errors gracefully.

Links and References

• Braze API Documentation
• Braze Segments Overview
• ISO 8601 Date Format