Segment data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this segment object |
created_at | string (date-time) | No | The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The name of the segment/audience |
slug | string | No | The data-plane handle/key used to identify segment membership in profiles and destinations |
description | string | No | The description of the segment/audience |
definition | string | No | The membership rule/query that defines the segment |
type | enum | No | The type of entity the segment targets (USERS, ACCOUNTS, LINKED) Values: USERS, ACCOUNTS, LINKED |
compute_mode | enum | No | How the segment membership is computed (REALTIME or BATCH) Values: REALTIME, BATCH |
size | number | No | The number of profiles currently in the segment |
is_active | boolean | No | Whether the segment is active/enabled |
source_id | string | No | The cdp_source this segment originated from; points to CdpSource |
metadata | CdpMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | The attribute/trait key (eg. lifetime_value) |
metadata[].value | object | No | The attribute/trait value |
metadata[].namespace | string | No | The scope or origin of the attribute (eg. computed, event, visitor) |
metadata[].format | enum | No | The data type of the attribute value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No |
Are we missing anything? Let us know