The segment object

This entity describes a customer segment.

AttributeDescriptionExample
id stringseg_TC5iH4KqbpISfyXDiue1t78a
object stringType of the object represented by JSON. Value is segment.
name stringxyz
created_at string, ISO 8601 date format2016-11-16T14:14:31Z
metadataStores custom meta data"metadata": { "test": true, "locale": "pl-en" }
type stringCan be static or auto-update.auto-update
filters objectDefines which customers belong to the segment.{ "junction":"and", "loyalty.campaigns.FRF-campaign.referred_customers":{ "conditions":{ "$more_than":[ 0 ] } } }
{
  "id":"seg_9e3ALnjEWVwYGt3zWL96aQQR",
  "name":"ref",
  "created_at":"2016-12-15T15:39:23Z",
  "metadata":{

  },
  "filter":{
    "junction":"and",
    "loyalty.referred_customers.campaigns.Referral Campaign 10":{
      "conditions":{
        "$less_than":[
          "2"
        ]
      }
    },
    "name":{
      "conditions":{
        "$starts_with":[
          "Tom"
        ]
      }
    }
  },
  "customers":null,
  "type":"auto-update",
  "object":"segment"
}