List of segmentation fields
Segmentation queries or expressions can contain any combination of the Fields described in the following tables. You can use either the field name or the corresponding code in your JSON request body. Some fields accept these additional parameters:
-
Date Constrain- constrains the results based on a related date field. -
OtherMailingListId- runs the query on another email list on members that are contained in both the current and the other email list. -
CustomFieldIdorCustomFieldName- used only withCustomFieldand specifies the custom field definition by the ID or the name for which the query applies. The custom field definition can be either one of the current email lists or the email list specified by theOtherMailingListIdparameter.
| Member fields | Code | Data type | Date constrain | OtherMailingListId |
|---|---|---|---|---|
| DateAdded | 1 | dateTime | Yes | |
| DateUpdated | 16 | dateTime | Yes | |
| RecipientName | 2 | string | Yes | |
| RecipientEmail | 3 | string | ||
| SubscribeMethod | 14 | enum | Yes (SubscribedOn) | Yes |
| CustomField | 99 | string, decimal, dateTime, Boolean | Yes | |
| MailingList | 17 | guid |
| Campaign fields | Code | Data type | Date constrain | OtherMailingListId |
|---|---|---|---|---|
| CampaignsOpened | 4 | integer | Yes (DeliveredOn) | Yes |
| LinksClicked | 5 | integer | Yes (DeliveredOn) | Yes |
| CampaignName | 6 | string | Yes (DeliveredOn) | Yes |
| CampaignTitle | 20 | string | Yes (Timestamp) | Yes |
| LinkURL | 7 | guid | Yes (DeliveredOn) | Yes |
| CampaignSent | 15 | guid | Yes (Timestamp) | Yes |
| OpenedAnyCampaign | 24 | Boolean | Yes (Timestamp) | Yes |
| CampaignID | 19 | guid | Yes (Timestamp) | Yes |
| SpecificCampaignClicked | 26 | string | Yes (Timestamp) | Yes |
| CampaignIdNotOpened | 27 | string | Yes |
| User agent fields | Code | Data type | Date constrain | OtherMailingListId |
|---|---|---|---|---|
| Platform | 8 | enum (Desktop = 1, Mobile = 2, Other = 3) | ||
| OperatingSystem | 9 | string | ||
| EmailClient | 10 | string | ||
| WebBrowser | 11 | string | ||
| MobileBrowser | 12 | string |
| Website fields | Code | Data type | Date constrain | OtherMailingListId |
|---|---|---|---|---|
| AddedAnythingToCart | 21 | Boolean + extra (CampaignId, ProductCode, WebsiteId, Times) | Yes (Timestamp) | Yes |
| ViewedProduct | 22 | Boolean + extra (CampaignId, ProductCode, WebsiteId, Times) | Yes (Timestamp) | Yes |
| PurchasedProduct | 23 | Boolean + extra (CampaignId, ProductCode, WebsiteId, Times) | Yes (Timestamp) | Yes |
If you have suggestions for improving this article, let us know!