Outreach Segments (Full Update)
Description
See the Aerial Spec for more details.
File Naming Convention
TGEN_outreachSegments_fullupdate_2025-12_<optionalSuffix>.csv
importType:fullupdateapiVersion:2025-12
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.rules[0].additionalFieldAlias | When set, exposes this rule’s own column as an additional field with this alias. | string | No | |
rules[0].field.rules[0].orderByDirection | When set, uses this rule’s column for ordering. | Allowed: ASC, DESC | mixed | No |
rules[0].field.rules[0].orderByPriority | Position in the ORDER BY clause (lower = first). | integer | No | |
rules[0].field.rules[0].additionalFields | Extra columns from this rule’s table to expose as additional fields. | array | No | |
rules[0].field.rules[0].additionalFields[0] | Array element | mixed | No | |
rules[0].field.additionalFields | Segment-level additional fields joined independently to the main customer table | 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. | string | No | |
rules[0].field.additionalFields[0].alias | An optional alias for the field in the output. | string | No | |
rules[0].field.additionalFields[0].orderByDirection | Sort direction for this field (ASC or DESC). | mixed | No | |
rules[0].field.additionalFields[0].orderByPriority | Priority for ordering (lower values are applied first). | integer | 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 | |
rules[0].additionalFieldAlias | When set, exposes this rule’s own column as an additional field with this alias. | string | No | |
rules[0].orderByDirection | When set, uses this rule’s column for ordering. | Allowed: ASC, DESC | mixed | No |
rules[0].orderByPriority | Position in the ORDER BY clause (lower = first). | integer | No | |
rules[0].additionalFields | Extra columns from this rule’s table to expose as additional fields. | array | No | |
rules[0].additionalFields[0] | Array element | mixed | No | |
rules[0].additionalFields[0].segmentRuleField | The UUID or external ID of the segment rule field for the extra column to expose from this rule’s table. | string | Yes | |
rules[0].additionalFields[0].alias | An optional alias for the additional field in the result set. | string | No | |
rules[0].additionalFields[0].orderByDirection | Optional sort direction for this field. When set, this field contributes to the query ORDER BY. | Allowed: ASC, DESC | mixed | No |
rules[0].additionalFields[0].orderByPriority | Position in the ORDER BY clause (lower = first). Required when orderByDirection is set. | integer | No | |
additionalFields | Segment-level additional fields joined independently to the main customer table | array | No | |
additionalFields[0] | Array element | mixed | No | |
additionalFields[0].segmentRuleField | The UUID or external ID of the segment rule field. | string | No | |
additionalFields[0].alias | An optional alias for the field in the output. | string | No | |
additionalFields[0].orderByDirection | Sort direction for this field (ASC or DESC). | mixed | No | |
additionalFields[0].orderByPriority | Priority for ordering (lower values are applied first). | integer | No |
Sample CSV
See the following outreachSegments CSV sample file.
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment.