Outreach Segments (Full Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_outreachSegments_fullupdate_2025-08_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-08
Columns
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
externalId | External identifier of the segment | string | No | |
name | Name of the segment | string | No | |
description | Description of the segment | string | No | |
type | Type of the segment | mixed | No | |
operator | Operator used to combine segment rules | mixed | No | |
isTemplate | Whether or not this segment can be used as a template when creating a campaign | boolean | No | |
rules | List of associated rules for this segment | array | No | |
rules[0] | Array element | mixed | No | |
rules[0].externalId | External identifier of the segment rule | string | No | |
rules[0].segment | Identifier of the segment this rule belongs to | string | No | |
rules[0].fieldSource | Source of the field used in the rule | mixed | No | |
rules[0].field | Identifier of the field or segment used in the rule | object | No | |
rules[0].field.externalId | External identifier of the segment | string | No | |
rules[0].field.name | Name of the segment | string | No | |
rules[0].field.description | Description of the segment | string | No | |
rules[0].field.type | Type of the segment | mixed | No | |
rules[0].field.operator | Operator used to combine segment rules | mixed | No | |
rules[0].field.isTemplate | Whether or not this segment can be used as a template when creating a campaign | boolean | No | |
rules[0].field.rules | List of associated rules for this segment | array | No | |
rules[0].field.rules[0] | Array element | mixed | No | |
rules[0].field.rules[0].externalId | External identifier of the segment rule | string | No | |
rules[0].field.rules[0].segment | Identifier of the segment this rule belongs to | string | No | |
rules[0].field.rules[0].fieldSource | Source of the field used in the rule | mixed | No | |
rules[0].field.rules[0].field | Identifier of the field or segment used in the rule | object | No | |
rules[0].field.rules[0].comparator | Enum comparator used in the rule. This matches the available enum values for the datatype of the segmetn rule field. If the source is a segment, the available fields match a Boolean rule field. | string | No | |
rules[0].field.rules[0].value | Value used in the rule. This is a stringified JSON object for the shape the value should be in based on the comparator. | string | No | |
rules[0].field.rules[0].negateQuery | Whether to negate the query for this rules field. | boolean | No | |
rules[0].field.orderings | A list of named ordering configurations for this segment. Can be an identifier or an object. | array | No | |
rules[0].field.orderings[0] | Array element | mixed | No | |
rules[0].field.orderings[0].name | The name of the ordering configuration. | string | No | |
rules[0].field.orderings[0].isDefault | Whether this ordering is the default for the segment. | boolean | No | |
rules[0].field.orderings[0].columns | An array of columns to define the sorting order. | array | No | |
rules[0].field.orderings[0].columns[0] | Array element | mixed | No | |
rules[0].field.additionalFields | A list of additional fields to be included by default when previewing the segment. | array | No | |
rules[0].field.additionalFields[0] | Array element | mixed | No | |
rules[0].field.additionalFields[0].segmentRuleField | The UUID or external ID of the segment rule field to include in the output. The rule field must have a table and column defined. | string | No | |
rules[0].field.additionalFields[0].alias | An optional alias for the additional field in the result set. If not provided, a default alias will be generated from the rule field’s name. | string | No | |
rules[0].comparator | Enum comparator used in the rule. This matches the available enum values for the datatype of the segmetn rule field. If the source is a segment, the available fields match a Boolean rule field. | string | No | |
rules[0].value | Value used in the rule. This is a stringified JSON object for the shape the value should be in based on the comparator. | string | No | |
rules[0].negateQuery | Whether to negate the query for this rules field. | boolean | No | |
orderings | A list of named ordering configurations for this segment. Can be an identifier or an object. | array | No | |
orderings[0] | Array element | mixed | No | |
orderings[0].name | The name of the ordering configuration. | string | No | |
orderings[0].isDefault | Whether this ordering is the default for the segment. | boolean | No | |
orderings[0].columns | An array of columns to define the sorting order. | array | No | |
orderings[0].columns[0] | Array element | mixed | No | |
orderings[0].columns[0].direction | The direction of the sort. | Allowed: ASC, DESC | string | No |
orderings[0].columns[0].segmentRuleField | The UUID or external ID of the segment rule field to order by. | string | No | |
orderings[0].columns[0].alias | An optional alias for the ordering column in the result set. If provided, the sorted column will be included in the output with this alias. | string | No | |
additionalFields | A list of additional fields to be included by default when previewing the segment. | array | No | |
additionalFields[0] | Array element | mixed | No | |
additionalFields[0].segmentRuleField | The UUID or external ID of the segment rule field to include in the output. The rule field must have a table and column defined. | string | No | |
additionalFields[0].alias | An optional alias for the additional field in the result set. If not provided, a default alias will be generated from the rule field’s name. | string | No |
Sample CSV
See the following outreachSegments CSV sample file.