Segments

A segment is a group of customers, such as VIP, New this month or Dar es Salaam. You pick who is in it by hand, or turn on Automatic segmentation and let rules decide. A customer can be in up to 20 segments picked by hand, and you can have up to 500 segments.

Create a segmentCopy Anchor Link

In Customers → Segments, select New segment. Give it a name, a colour, and optionally a description.

You can also create one as you go: type a new name in a customer's Segments, or in your import file.

Add customers to a segmentCopy Anchor Link

• From the list: in All customers, select customers and choose Add to segment.
• From the segment: open it and select Add customers.
• From a customer: edit them and choose their segments.
• By import: name segments in your file's Segments column.

To take customers out, select them in All customers and choose Remove from segment.

Automatic segmentsCopy Anchor Link

An automatic segment fills itself. Instead of adding customers, you give it rules, such as "Purchased at least twice in the last 30 days" or "Plan is gold". Customers who match are in it, and they leave when they no longer match. No one is added or removed by hand.

1. In Customers → Segments, select New segment, and give it a name.
2. Turn on Automatic segmentation.
3. Under Rules, choose whether customers match All conditions or Any condition, then select Add condition for each one, up to 10.

As you add conditions, the form shows how many customers match now, and a few of them.

A value such as 25,000 is compared as a number, and Yes or No as yes or no.

Who is in an automatic segment is worked out each time you use it: when you open it, filter customers by it, or send it a broadcast. It shows on each matching customer, next to their other segments. You can have up to 50 automatic segments, and a segment stays automatic, or picked by hand, as it was made.

Delete a segmentCopy Anchor Link

Open the segment and select Delete segment. Its customers stay; they're only no longer grouped. A segment that an automatic segment's rules use can't be deleted until you change those rules.

Through the APICopy Anchor Link

Send rules when you create a segment with POST /v1/segments:

curl https://api.goomzo.africa/v1/segments \
  -H "Authorization: Bearer $GOOMZO_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Regular buyers",
    "rules": {
      "match": "all",
      "conditions": [
        { "type": "activity", "key": "purchased", "op": "atLeast", "count": 2, "withinDays": 30 },
        { "type": "contact", "op": "hasPhone" }
      ]
    }
  }'

match is all or any. Each condition has a type, and what that type needs:

withinDays is from 1 to 3,650. A problem is named by where it is, such as rules.conditions[1].value.

• See who matches first: send the same rules to POST /v1/segments/preview. It answers with count and the five newest matching customers.
• What you get back: segments have kind, manual or rules, and their rules. customerCount is who matches now. A customer's segments include the automatic ones they match.
• Change the rules with PATCH /v1/segments/{id} and new rules. A segment picked by hand can't be given rules.
• No one is added by hand: adding customers to an automatic segment, or naming it in a customer's segments when you add customers, is refused with segment_fills_itself. Setting a customer's segments with PUT /v1/customers/{id}/segments leaves automatic ones out, so you can send back what you read.

Next stepsCopy Anchor Link