This entity describes a customer segment.
Attribute | Description | Example |
---|---|---|
id string | seg_TC5iH4KqbpISfyXDiue1t78a | |
object string | Type of the object represented by JSON. Value is segment . | |
name string | xyz | |
created_at string , ISO 8601 date format | 2016-11-16T14:14:31Z | |
metadata | Stores custom meta data | "metadata": { "test": true, "locale": "pl-en" } |
type string | Can be static or auto-update . | auto-update |
filters object | Defines 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"
}