Segment data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

idstring
Unique identifier for this segment object
created_atdate
The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The name of the segment/audience
slugstring
The data-plane handle/key used to identify segment membership in profiles and destinations
descriptionstring
The description of the segment/audience
definitionstring
The membership rule/query that defines the segment
type enum
Valid values:
"USERS"
"ACCOUNTS"
"LINKED"
The type of entity the segment targets (USERS, ACCOUNTS, LINKED)
compute_mode enum
Valid values:
"REALTIME"
"BATCH"
How the segment membership is computed (REALTIME or BATCH)
sizenumber
The number of profiles currently in the segment
is_activeboolean
Whether the segment is active/enabled
source_idstring
The cdp_source this segment originated from; points to CdpSource
Are we missing anything? Let us know
Was this page helpful?