Engage Segments Builder Tutorial

Segments are reusable audience selection criteria. Create a segment instead of recreating your audience selections every time you send a message. You can edit a segment at any time.

Segments are constructed using combinations of tags, lists, device properties, location (API only), and location history. They are created within a project and can be used for any message within that project.

See also: Targeting.

Note

Segments can also be created via the API. See:

What You'll Do

In this tutorial, you will:

  1. Select a condition type: Location, Tag, or List.
  2. Optionally include nested logic.
  3. Name the segment.
  4. Save the segment for use.

Features and options are explained along the way.

Steps

Note

Not supported for Web Notify: Location, Tag Predicted to Churn, and Lists.

Create a New Segment

  1. Open your project from the dashboard, then click Audience and select Segments.
    Click the New Segment button to open the Segments Builder.

  2. Select a Condition type from the dropdown menu. Your first condition has the default selection Tag.If you would like to set multiple conditions, click the + add a condition button and continue with your specifications. Steps for each condition type:

    Location
    Tag
    List
  3. Optionally include nested logic. Click the gear icon at the end of a condition's row, and select Add an Alternative. You also have the option here to Remove Condition.
  4. Optionally change Boolean logic values that will apply to each segment condition. The default statement is "If All of the following are True." Use the All/Any and True/False dropdown menus to change your selections. You can change the Boolean logic for the nested statements as you can for the entire expression.

    All = all criteria must be met (Boolean AND)
    Any = any criteria must be met (Boolean OR)
  5. Enter a descriptive Name.

  6. Click the Save button, or cancel to discard.

Navigate to Audience » Segments to return to your list of segments.

Location

If your app uses Urban Airship's historical location service, you may include location criteria in your Segments. Three months' location history is the default data retention package, with options to retain six or twelve months' location history. See the Data Retention Schedule.

Add location criteria for users who have or have not recently been in a location within a defined time period.

  1. Select Location from the segment condition dropdown menu.

  2. Choose has been or has not been from the next dropdown menu.

  3. Click the Select a location button, search or explore locations, and apply your selection. See Location Picker for usage detail.

  4. Constrain the time period for the location event. The default statement is "within the last 6 hours." Use the dropdrown menus to choose within the last or between.For within the last, enter a numerical value and select hours, days, weeks, or months. Always use a number greater than 1, otherwise the system will only check the current period. We recommend using long time periods during testing. See Time Bucketing: "Within the Last X" for additional detail.

    For between, click the Select a date range button. Click a Select by option to choose a range type. Make your selections for both Start Date and End Date, then click the Apply button.

    • Year, Month, Week, and Day display a calendar on the left side of the pane. Click to make your selections.
    • Hour includes the calendar, as well as dropdown menus for the time and AM/PM.

Tag

Tags are selected from — not created by — the Segments Builder.

Tags are created via the mobile app (or website for Web Notify) by sending a notification that adds that tag to users' devices, and at least one user must have interacted with that notification. Refer to Tag Options for tag names, and search and select details per tag type.

  1. Select Tag from the segment condition dropdown menu.

  2. Choose is or is not from the next dropdown menu.

  3. Click the Select a tag button and choose Primary Device Tags, Device Property Tags, Predicted to Churn, or a tag group, if any. Tag groups use the same search method as Primary Device Tags.

List

Include either Lifecyle Lists or Uploaded Lists in your segment. For more information, see: Audience: Lists.

  1. Select List from the segment condition dropdown menu.

  2. Choose is or is not from the next dropdown menu.

  3. Click the Select a list button and choose Lifecyle Lists or Uploaded Lists.
    • Lifecycle Lists are divided by type, then by time interval and associated Devices count. To select, click the time interval for a Lifecycle List type.
    • Uploaded Lists are searchable. Enter your search term, and click to select from the listed search results, if any.

Next Steps

Send a Message to a Segment

After you create a segment, you can use it as a recipient group when selecting your audience in the Message or A/B Test workflows. See Target Specific Users for detail.

To send to a segment via the API, see the Segments API documentation.

Saved Segments

Edit or Delete

From Audience » Segments, find the segment in the list, then click the segment name, or click the gear icon at the end of its row, and choose Edit Segment or Delete Segment. There is no confirmation step for deleting a segment.


When editing a segment, be mindful of any scheduled pushes that target that segment. If you have a scheduled push that targets a segment, and you edit that segment some time after the push's creation, the push audience will not be updated to match the new segment. The scheduled push will be sent to the version of the segment that existed when the push was created, rather than the updated version.

If you want the scheduled push to target the updated segment, you must manually update the push. Navigate to Messages » Messages Overview, and click the Scheduled tab. Find the push in the list, click the Edit icon at the end of its row, then click Yes to confirm. You do not need to change the message itself — just click Review & Schedule in the progress header, then click the Schedule Message button. The targeted audience will be updated to reflect the changes made to the edited segment.

Tag Options

These tag types are available to you when creating a tag-based segment condition.

  • Primary Device Tags are existing tags associated with your mobile audience. Enter your search term, and click to select from the listed search results, if any.

  • Device Property Tags are updated daily. Choose from the following, then enter your search term, and click to select from the listed search results, if any. Exceptions to Search are noted.
    Note

    Available tags vary by platform.

    Push Notification Opt-in: Select Opted-in or Opted-out.
    Timezone
    Language
    Language Country
    iOS App Version
    Android App Version
    iOS Version
    Android Version
    iOS Model
    iOS UA SDK Version
    Android UA SDK Version
    Background Enabled: Select Background Enabled or Background Disabled
    Location Enabled: Select Location Enabled or Location Disabled
    Browser Name
    Browser Type
    Browser Version
    Web SDK Version

  • Predicted to Churn tags are audience risk profiles based on user behaviors indicating they are likely to become inactive, and are updated weekly. See Settings: Configuration: Predictive to enable this for your app, and the Predictive Churn topic guide for usage information.

    High risk: Users most likely to become inactive.
    Medium risk: Users who exhibit signs of potentially becoming inactive.
    Low risk: Users least likely to become inactive.

Geographic Location Criteria

Note

Geographic Location Criteria is not supported for Web Notify.

Location Picker

When creating a location-based segment condition, you use the location picker, which has Search and Explore modes. Search is the initial mode.

Enter a search term in the box, and results, if any, display on the map and are listed in the right-side pane.

Explore

Click the Explore icon to the left of the search box, and results for the mapped area, if any, display on the map and are listed in the right-side pane. The quantity/density of location points is determined by the level of zoom. Click and drag, and use the +/-zoom controls to change the displayed area.

Click a location on the map, and its corresponding result will highlight in the results pane, and vice versa. Click again to toggle on/off the location boundary.

Click Filter Results at the top of the results pane, make selections by checking boxes, then click the Apply button. You may also use the All, None, and Clear options as you make your selections.

Time Bucketing: "Within the Last X"

When creating a location-based segment condition, you have the option to include location events that occurred "within the last" number of hours, days, weeks, or months.

Understanding how we "bucket" location events according to a given time period is important to know when using this feature.

  1. All time periods are in UTC.

  2. We view time in bucketed time periods for hours, days, weeks, and months.

    Hour starts at X:00 UTC
    Day starts at 12:00 AM UTC
    Week starts at 12:00 AM UTC on Monday
    Month starts at 12:00 AM UTC on the first day of month

  3. When choosing "within the last" for a given time period, you are selecting all location events that have occurred from the beginning of the most recent time bucket until now.

    Examples

    1. "within the last 1 hour" does not equal the last 60 minutes. It equals the time from the beginning of the current hour (UTC) until the time the segment is created.

      If you create a “within the last 1 hour” segment at 11:19 AM, you will have a segment that contains all devices that were in location X from 11:00 AM UTC until 11:19 AM UTC.

    2. "within the last 1 day" does not equal the last 24 hours. It equals the time from 12:00 AM UTC on the day the segment is created until the moment the segment is created.

      If you create a “within the last 1 day” segment at 11:19 AM, you will have a segment that contains all devices that were in location X from 12:00 AM UTC until 11:19am UTC.

    3. "within the last 2 weeks" does not equal the last 14 days. It equals a full 7-day week (the week preceding the current week) AND whatever portion of the current calendar week that has passed when the segment is created.

      If you create a “within the last 2 weeks” segment at 11:00am on Wednesday, August 12, you will have a segment that contains all devices that were in location X from 12:00am UTC, Monday, August 3, until 11:00am UTC, Wednesday, August 12.

Estimated Audience

Before pushing to a segment, you may want to know how many recipients are included in that segment. The Estimated Audience is displayed in the lower right corner in the Segment Builder when you are creating, editing, or viewing a segment.

To view an existing segment, from Audience » Segments, find the segment in the list, then click the segment name, or click the gear icon at the end of its row, and choose Edit Segment.

Two rows show the total Estimated Audience and Opted-In counts, as well as counts per configured platform. The values update dynamically following each change to segment conditions.

  • Estimated Audience is the total estimated audience accessible through push notifications, in-app messages, and Message Center.
  • Opted-In contains members of Estimated Audience who have opted-in to receiving push notifications.

Estimates are based on a sampling of your audience that meets the segment criteria. A 95% confidence interval is calculated from the sample, and the rounded midpoint of each interval is displayed.

For a more detailed look at the estimate, hover over any value to see the confidence interval upper and lower bounds, giving you an idea of how much variance the estimate involves.


Note

Due to a number of potential unknowns, including device on/off states, connectivity, and the disparities and limitations of iOS and Android, it is impossible to measure and maintain with 100% certainty the number of recipients. Given these constraints, our sampling model provides the most up-to-date estimate possible.

Tutorials