Skip to main content
Segments are saved audience rules. They combine contact data, tags, custom attributes, membership, checkout, and activity.

​
Tags

Tags are team-scoped labels you can attach to team contacts. 
GET  /api/v1/teams/{team_id}/tags
POST /api/v1/teams/{team_id}/tags
POST /api/v1/teams/{team_id}/contacts/{team_contact_id}/tags
Use tags for simple lifecycle markers such as vip, trial, webinar-attendee, or needs-follow-up.

​
Contact attributes

Attributes are custom fields for a team’s contacts. They can be visible in profiles or onboarding. 
GET  /api/v1/teams/{team_id}/contact-attributes
POST /api/v1/teams/{team_id}/contact-attributes
GET  /api/v1/hub/{team_id}/hubs/{hub_id}/onboarding-attributes
POST /api/v1/hub/{team_id}/hubs/{hub_id}/onboarding-attributes

​
Activity

Activity tracks behavior such as login, search, lesson started, and lesson completed. 
POST /api/v1/hub/{hub_id}/activity                                      record an activity event (contact-auth)
GET  /api/v1/teams/{team_id}/hubs/{hub_id}/activity/contacts/{contact_id}  get stats for one contact (admin)
GET  /api/v1/teams/{team_id}/hubs/{hub_id}/activity/top-engaged         list top-engaged contacts (admin)

​
Segments

Segments combine conditions and return matching contacts. 
POST /api/v1/teams/{team_id}/segments
POST /api/v1/teams/{team_id}/segments/search
GET  /api/v1/teams/{team_id}/segments/{segment_id}/members
GET  /api/v1/teams/{team_id}/segments/{segment_id}/members/count
Use segments to answer practical questions:
  • Who bought Product A but has not completed onboarding?
  • Who watched fewer than three lessons this month?
  • Who is tagged vip and has not logged in recently?
  • Who should get a reactivation email?