Get Segment

GET /segment

Get plaintext list of user_ids matching segment criteria. See product documentations for full description of segment criteria.

Request Parameters

Query Parameters

Name	Type	Description
asset_ids	string	Comma delimited list of asset ids to use as the bases for the segment. Users with growth value recommendations for the supplied asset ids will be included in the segment. Either asset_ids or labels must be provided for segments. If asset_ids are provided labels are ignored.
labels	string	Comma delimited list of labels to use as the bases for the segment. Users with growth value recommendations for the supplied labels ids will be included in the segment. Either asset_ids or labels must be provided for segments. If asset_ids are provided labels are ignored.
action_types	string	Optional comma delimited list of recommended action types (same list as event types) to use as a recommendations FILTER for the asset list provided. Only asset recommendations of the provided action types will be included in the segment.
match_type		Default: any Indicates if membership in the segment requires match for all assets/labels or any (default).
segment_type		Default: growth Indicates if the segment should consider all growth values (default), only values matching a user history (base), or only values that are net new for the user (discovery).See product documentation for more details about segment types
min_weight	number	Default: 0.5 Minimum weight allowable for asset and label recommendations to qualify for the segment.
force_refresh	boolean	Default: False Recalculate the segment and do not use the cache

Header Parameters

Name	Type	Description
program-id required	string

Responses

200 Successful Response

422 Validation Error

HTTPValidationError | application/json

Name	Type	Properties
detail	array	items: {'$ref': '#/components/schemas/ValidationError'}

ValidationError | application/json

Name	Type	Properties
loc required	array	items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]}
msg required	string
type required	string