Skip to main content

Segment

Stored in the segments collection. createdAt and updatedAt are maintained automatically.

Returned by GET /segment, POST /segment, GET /segment/:id, PUT /segment/:id, GET /segment/execute.

FieldTypeNotes
namestringrequired
descriptionstring
companyObjectId -> Company
filterTypestringdefault AND · one of AND, OR
filtersobject[]default []
filters.conditionTypestringdefault AND · one of AND, OR
filters.conditionsobject[]default []
filters.conditions.fieldIdstringrequired
filters.conditions.fieldTypestring
filters.conditions.dependencySelectionsanydefault {}
filters.conditions.operatorstringrequired · one of is, is not, contains, starts with, has all, has any, does not have, greater than and 8 more
filters.conditions.operatorsstring[]default []
filters.conditions.valueany
filters.conditions.sourceFieldIdstring
filters.conditions.nestedPathstring[]default []
filters.conditions.isNestedCustomFieldboolean
filters.conditions.parentCollectionTypestring
filters.conditions.pathLabelstring
filters.conditions.typestring
filters.conditions.panelstringdefault contact · one of contact, lead, productService
cachedCountnumberdefault 0
lastRefresheddate
isActivebooleandefault true
typestringdefault contact · one of contact, lead, product, service
createdByObjectId -> Member
updatedByObjectId -> Member
_idObjectIddefault "6a95712f932657988a91c0d3"
createdAtdateset once
updatedAtdate