Segmentation

What's a segment?

• Action - customer visits the checkout page.

• Inaction - customer does not buy within 2 minutes.

Create segment definitions

• When creating a live-segment definition, the segment_timeframe parameter must have an integer value of "0".

• The profile_property_name and profile_property_value parameters only need to be provided when creating a past-segment with a sub_type of 3 or 4.

• The exp_timeframe parameter within an event_sequence↳event object MUST be set to an integer value of "0" if there are no subsequent events, or the segment_type parameter is set to "past"

• The exp_timeframe parameter within an event_sequence↳event object MUST be set to an integer value equal to or greater than “5” (minutes) if there ARE subsequent events and the segment_type parameter is set to "live"

• This is not mandatory, however, it is advised to only add existing event-types with event_properties, keys and desired values into the event_sequence parameter.

• When providing event properties, you do not have to specify all the key : value pairs associated with the relevant event-type. However any provided keys must exist within the system event-type or custom event-type event_properties attribute. For example: the charged system event-type has two keys defined in its event_properties attribute, item_id and payment_method. Let’s say you wish to add an event to the event sequence, specifying that a customer must perform a charged event with any payment method, but for a specific item only. In this case, you would only need to provide the key-value pair item_id : "id of specific item". Optionally, you can provide a 'null' value for the event_properties parameter, signifying that all events of the specified event-type would meet this events criteria within the event sequence.

• There is a maximum of 10 event objects allowed within the event_sequence parameter of each segment definition.

• With each event object, it should be specified as to whether the event is required to happen (action) or not (inaction) by setting the action_inaction parameter to either "action" or "inaction".

• Duplicate event-types with matching event_properties parameters cannot be supplied within the event_sequence parameter.

• The first index of the event sequence array MUST always be an action, regardless of segment-type or sub-type.

• Segments with a sub-type 2 or 4 (irrespective of primary-segment-type) MUST contain one inaction event in their event sequence. This inaction event must also always be the last index of the event sequence.

• Segments with a sub-type 1 or 3 (irrespective of primary-segment-type) must NOT contain an 'inaction' event in their event sequence.

• Live-segments with a sub-type 1, can only contain a singular 'action' event in their event sequence.

octy-cli apply --filepath {path/to/segment-definitions.yml}

kind: segments
segmentDefinitions:
    # Customers who login and make a purchase within 5 minutes
    - segmentName: fast paying customers
        segmentType: live
        segmentSubtype: 2
        segmentTimeframe: 0
        eventSequence:
            - eventType: login
              expTimeframe: 5
              actionInaction: action
            - eventType: charged
              expTimeframe: 0
              actionInaction: inaction
              eventProperties:
                item_id : ios
                payment_method : visa
        profilePropertyName:
        profilePropertyValue:

    # Customers that have accessed your systems but made no purchase in the past 60 days
    - segmentName: worst customers
        segmentType: past
        segmentSubtype: 2
        segmentTimeframe: 60
        eventSequence:
            - eventType: login
              expTimeframe: 0
              actionInaction: action
            - eventType: charged
              expTimeframe: 0
              actionInaction: inaction
        profilePropertyName:
        profilePropertyValue:

Segment tags

• A profile meets the criteria for a segment named best_customers.

• A segment tag would be added to the existing array of segment_tags attribute for this profile.

{
(Other profile attributes) ...,

"segment_tags" : [
    {
        "segment_tag" : "existing_segment_tag1",
        "created_at" : "Tue, 18 May 2021 17:26:45 GMT"
    },
    {
        "segment_tag" : "existing_segment_tag2",
        "created_at" : "Wed, 19 May 2021 22:46:23 GMT"
    },
    
    {
        "segment_tag" : "best_customers",
        "created_at" : "Thur, 20 May 2021 09:37:12 GMT"
    }
    
]
}

Next steps