Skip to main content

Overview

A Segment is a dynamic group of records of one object type — contacts, orders, and more — defined by a saved filter. Membership is automatic: a record joins or leaves a segment as its data changes, so a segment always reflects the current state. Segments power audience management, reporting, and data activation. For the bigger picture, see the Customer Data overview.

Where to find it

Segments live under Customer Data → Utilities → Segments. You can also apply a segment from a list table’s segment picker.

Properties

PropertyTypeRequiredDescription
titlestringYesDisplay name (e.g. Active Customers).
slugstringYesIdentifier — unique.
descriptionstringNoOptional description.
object_typestringYesThe one object type the segment targets (contacts, orders, …).
queryobjectYesThe saved filter that defines membership, built in the advanced filters.

How membership works

  • Dynamic — when a record is created, updated, or restored, it’s evaluated against the segments for its type and added or removed automatically.
  • One object type per segment — a segment targets a single object type.
  • Counts on demand — a segment’s record count is computed when you view it, so it’s always accurate (not cached).

Filtering across relationships

A segment’s filter can reach into relationships — for example, filtering contacts by the attributes of the organization they belong to — while still returning a contact-focused set. Conditions combine with boolean logic to build complex cohorts.

Segments and Views

A segment captures which records match. Saving that filter as a View also captures what to show — the columns, labels, and relationships — for reuse and for activation: feeding the audience to downstream marketing, sales, and support tools.

Seeds

Segments travel between environments as structural Seeds. A segments item carries the segment’s title, slug, target object type, and its saved-filter query (exactly as built in the advanced filters):
[
  {
    "object_type": "segments",
    "data": {
      "title": "Active Customers",
      "slug": "active-customers",
      "description": "Contacts with recent activity",
      "object_type": "contacts",
      "query": { "...": "the saved filter" }
    }
  }
]

Governance & permissions

Only a super admin or Master can create, edit, and delete segments.

API access

Segments have full CRUD, plus an on-demand endpoint that returns record counts for a set of segments. See the API reference.

Views

Save a segment’s filter as a reusable view.

Contacts

The most common segment target.

Organizations

Filter contacts by their organization’s attributes.