--- title: Get segment slug: data-platform/api/get-segment docTags: createdAt: 2026-09-02T14:41:00.110Z --- { "id": "ahijjC09rFrvgiqze0rzK", "type": "api-oas-v2", "data": { "method": "GET", "url": "//api.us1.odp.optimizely.com/v3/segments/{segment_id}", "servers": [ { "url": "//api.us1.odp.optimizely.com/v3/segments/{segment_id}" } ], "name": "Get segment", "description": "

Returns the schema of a requested segment. Note: this does not return the list of members in the segment.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "segment_id", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "x-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "A successful response.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "GetSegmentResponse", "schema": [ { "name": "revision", "kind": "optional", "type": "integer", "description": "", "example": 1, "format": "int32" }, { "name": "description", "kind": "optional", "type": "string", "description": "", "example": "Customer has email" }, { "name": "metadata", "kind": "optional", "type": "map", "description": "", "example": "{\"display_name\":\"Customer Has Email\"}", "customType": "map", "schema": [] }, { "name": "definition", "kind": "optional", "type": "object", "description": "", "example": "{\"root_condition\":{\"customer_condition\":{\"customer_filter\":{\"is_not_missing\":{\"source\":{\"path_reference\":{\"value\":\"customer.email\"}}}}}}}", "modelRef": "#/components/schemas/SegmentDefinition", "customType": "SegmentDefinition", "schema": [ { "name": "root_condition", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Condition", "customType": "Condition", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Condition.Combination", "customType": "Condition.Combination", "schema": [ { "name": "conjunction", "kind": "optional", "type": "string", "description": "", "default": "CONJUNCTION_NOT_SET", "modelRef": "#/components/schemas/Conjunction", "customType": "Conjunction", "schema": [] }, { "name": "conditions", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Condition", "customType": "Condition[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] }, { "name": "customer_condition", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CustomerCondition", "customType": "CustomerCondition", "schema": [ { "name": "customer_filter", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Expression.Combination", "customType": "Expression.Combination", "schema": [ { "name": "conjunction", "kind": "optional", "type": "string", "description": "", "default": "CONJUNCTION_NOT_SET", "modelRef": "#/components/schemas/Conjunction", "customType": "Conjunction", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "expressions", "kind": "optional", "type": "array", "description": "

Cannot be empty; all must evaluate to boolean.

", "modelRef": "#/components/schemas/Expression", "customType": "Expression[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "comparison", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Comparison", "customType": "Comparison", "schema": [ { "name": "lhs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "comparator", "kind": "optional", "type": "string", "description": "", "default": "COMPARATOR_NOT_SET", "modelRef": "#/components/schemas/Comparator", "customType": "Comparator", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "rhs", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "path_reference", "kind": "optional", "type": "object", "description": "Evaluates to type of referenced field.", "modelRef": "#/components/schemas/PathReference", "customType": "PathReference", "schema": [ { "name": "value", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "string_literal", "kind": "optional", "type": "object", "description": "Evaluates to string.", "modelRef": "#/components/schemas/StringLiteral", "customType": "StringLiteral", "schema": [ { "name": "value", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "number_literal", "kind": "optional", "type": "object", "description": "Evaluates to number.", "modelRef": "#/components/schemas/NumberLiteral", "customType": "NumberLiteral", "schema": [ { "name": "value", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "boolean_literal", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/BooleanLiteral", "customType": "BooleanLiteral", "schema": [ { "name": "value", "kind": "optional", "type": "boolean", "description": "" } ] }, { "name": "is_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsMissing", "customType": "IsMissing", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "is_not_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotMissing", "customType": "IsNotMissing", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "false_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/FalseOrMissing", "customType": "FalseOrMissing", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "true_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/TrueOrMissing", "customType": "TrueOrMissing", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "coalesce", "kind": "optional", "type": "object", "description": "Evaluates to type of source.", "modelRef": "#/components/schemas/Coalesce", "customType": "Coalesce", "schema": [ { "name": "sources", "kind": "optional", "type": "array", "description": "Must all evaluate to same type.", "modelRef": "#/components/schemas/Expression", "customType": "Expression[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "truncate_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/TruncateTime", "customType": "TruncateTime", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "unit", "kind": "optional", "type": "string", "description": "", "default": "TIME_UNIT_NOT_SET", "modelRef": "#/components/schemas/TimeUnit", "customType": "TimeUnit", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "timezone", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "shift_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/ShiftTime", "customType": "ShiftTime", "schema": [ { "name": "source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "amount", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "unit", "kind": "optional", "type": "string", "description": "", "default": "TIME_UNIT_NOT_SET", "modelRef": "#/components/schemas/TimeUnit", "customType": "TimeUnit", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "timezone", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfString", "customType": "AnyOfString", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "any_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfNumber", "customType": "AnyOfNumber", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfString", "customType": "NoneOfString", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "none_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfNumber", "customType": "NoneOfNumber", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "like_any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeAnyOfString", "customType": "LikeAnyOfString", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "like_none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeNoneOfString", "customType": "LikeNoneOfString", "schema": [ { "name": "needle", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "haystack", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "is_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsListMember", "customType": "IsListMember", "schema": [ { "name": "list", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "is_not_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotListMember", "customType": "IsNotListMember", "schema": [ { "name": "list", "kind": "optional", "type": "string", "description": "" } ] } ] } ] }, { "name": "sequence_condition", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SequenceCondition", "customType": "SequenceCondition", "schema": [ { "name": "sequence", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Sequence", "customType": "Sequence", "schema": [ { "name": "entry_event_filter", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Expression.Combination", "customType": "Expression.Combination", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "comparison", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Comparison", "customType": "Comparison", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "path_reference", "kind": "optional", "type": "object", "description": "Evaluates to type of referenced field.", "modelRef": "#/components/schemas/PathReference", "customType": "PathReference", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "string_literal", "kind": "optional", "type": "object", "description": "Evaluates to string.", "modelRef": "#/components/schemas/StringLiteral", "customType": "StringLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "number_literal", "kind": "optional", "type": "object", "description": "Evaluates to number.", "modelRef": "#/components/schemas/NumberLiteral", "customType": "NumberLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "boolean_literal", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/BooleanLiteral", "customType": "BooleanLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsMissing", "customType": "IsMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_not_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotMissing", "customType": "IsNotMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "false_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/FalseOrMissing", "customType": "FalseOrMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "true_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/TrueOrMissing", "customType": "TrueOrMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "coalesce", "kind": "optional", "type": "object", "description": "Evaluates to type of source.", "modelRef": "#/components/schemas/Coalesce", "customType": "Coalesce", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "truncate_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/TruncateTime", "customType": "TruncateTime", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "shift_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/ShiftTime", "customType": "ShiftTime", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfString", "customType": "AnyOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "any_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfNumber", "customType": "AnyOfNumber", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfString", "customType": "NoneOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "none_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfNumber", "customType": "NoneOfNumber", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "like_any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeAnyOfString", "customType": "LikeAnyOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "like_none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeNoneOfString", "customType": "LikeNoneOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsListMember", "customType": "IsListMember", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_not_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotListMember", "customType": "IsNotListMember", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "unique_key_sources", "kind": "optional", "type": "array", "description": "

Optional, each must evaluate to a primitive.

", "modelRef": "#/components/schemas/Expression", "customType": "Expression[]", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Expression.Combination", "customType": "Expression.Combination", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "comparison", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/Comparison", "customType": "Comparison", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "path_reference", "kind": "optional", "type": "object", "description": "Evaluates to type of referenced field.", "modelRef": "#/components/schemas/PathReference", "customType": "PathReference", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "string_literal", "kind": "optional", "type": "object", "description": "Evaluates to string.", "modelRef": "#/components/schemas/StringLiteral", "customType": "StringLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "number_literal", "kind": "optional", "type": "object", "description": "Evaluates to number.", "modelRef": "#/components/schemas/NumberLiteral", "customType": "NumberLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "boolean_literal", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/BooleanLiteral", "customType": "BooleanLiteral", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsMissing", "customType": "IsMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_not_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotMissing", "customType": "IsNotMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "false_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/FalseOrMissing", "customType": "FalseOrMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "true_or_missing", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/TrueOrMissing", "customType": "TrueOrMissing", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "coalesce", "kind": "optional", "type": "object", "description": "Evaluates to type of source.", "modelRef": "#/components/schemas/Coalesce", "customType": "Coalesce", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "truncate_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/TruncateTime", "customType": "TruncateTime", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "shift_time", "kind": "optional", "type": "object", "description": "

Evaluates to number (epoch seconds).

", "modelRef": "#/components/schemas/ShiftTime", "customType": "ShiftTime", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfString", "customType": "AnyOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "any_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/AnyOfNumber", "customType": "AnyOfNumber", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfString", "customType": "NoneOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "none_of_number", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/NoneOfNumber", "customType": "NoneOfNumber", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "like_any_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeAnyOfString", "customType": "LikeAnyOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "like_none_of_string", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/LikeNoneOfString", "customType": "LikeNoneOfString", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsListMember", "customType": "IsListMember", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "is_not_list_member", "kind": "optional", "type": "object", "description": "Evaluates to boolean.", "modelRef": "#/components/schemas/IsNotListMember", "customType": "IsNotListMember", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "tracked_data", "kind": "optional", "type": "array", "description": "Optional.", "modelRef": "#/components/schemas/TrackedData", "customType": "TrackedData[]", "schema": [ { "name": "key", "kind": "optional", "type": "object", "description": "Must be unique within a SegmentDefinition.", "modelRef": "#/components/schemas/Key", "customType": "Key", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "source_path", "kind": "optional", "type": "string", "description": "

Path to a source object, eg: event.product or event.product.parent_product.

" }, { "name": "field_sub_paths", "kind": "optional", "type": "array", "description": "

Within the source, set of field sub-paths, eg: (product_id, category.name_0).

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "max_age_seconds", "kind": "optional", "type": "integer", "description": "

Must be between 1 and 2419200 (ie, 28 days).

", "format": "int32" }, { "name": "goal", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Continuation", "customType": "Continuation", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Continuation.Combination", "customType": "Continuation.Combination", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "event_filter", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "sequence_condition", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SequenceCondition", "customType": "SequenceCondition", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "timeout_source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "disqualifier", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Continuation", "customType": "Continuation", "schema": [ { "name": "combination", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Continuation.Combination", "customType": "Continuation.Combination", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "event_filter", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "sequence_condition", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/SequenceCondition", "customType": "SequenceCondition", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "timeout_source", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/Expression", "customType": "Expression", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "min_count", "kind": "optional", "type": "integer", "description": "

Optional, but at least one of min_count or max_count should be specified.

", "format": "int32" }, { "name": "max_count", "kind": "optional", "type": "integer", "description": "

Optional, cannot be less than min_count.

", "format": "int32" } ] } ] }, { "name": "collections", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Collection", "customType": "Collection[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "" }, { "name": "source", "kind": "optional", "type": "object", "description": "Must be unique within a SegmentDefinition.", "modelRef": "#/components/schemas/Key", "customType": "Key", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "narrowed_sub_paths", "kind": "optional", "type": "array", "description": "

Optional, a subset of the tracked data's sub-paths for narrowing the output.

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "unique", "kind": "optional", "type": "boolean", "description": "Only output unique rows." } ] } ] } ], "modelRef": "#/components/schemas/GetSegmentResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "zlEoNq8Ai_YZuIAxM8Il8", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url //api.us1.odp.optimizely.com/v3/segments/{segment_id} \\\n --header 'accept: application/json'" }, { "id": "9zSCf0iJduwXOYnQlsyNR", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"//api.us1.odp.optimizely.com/v3/segments/{segment_id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "FH_spW1LFE4EfKvE3zDyw", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"//api.us1.odp.optimizely.com/v3/segments/{segment_id}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "cpZrKMPIgY-cAxYc8mx4s", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"//api.us1.odp.optimizely.com/v3/segments/{segment_id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "zlEoNq8Ai_YZuIAxM8Il8" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// A successful response.\n{\n \"revision\": 1,\n \"description\": \"Customer has email\",\n \"metadata\": \"{\\\"display_name\\\":\\\"Customer Has Email\\\"}\",\n \"definition\": {\n \"root_condition\": {\n \"combination\": {\n \"conjunction\": \"\",\n \"conditions\": [\n {\n \"\": \"\"\n }\n ]\n },\n \"customer_condition\": {\n \"customer_filter\": {\n \"combination\": {\n \"conjunction\": \"\",\n \"expressions\": [\n {\n \"\": \"\"\n }\n ]\n },\n \"comparison\": {\n \"lhs\": {\n \"\": \"\"\n },\n \"comparator\": \"\",\n \"rhs\": {\n \"\": \"\"\n }\n },\n \"path_reference\": {\n \"value\": \"\"\n },\n \"string_literal\": {\n \"value\": \"\"\n },\n \"number_literal\": {\n \"value\": \"\"\n },\n \"boolean_literal\": {\n \"value\": false\n },\n \"is_missing\": {\n \"source\": {\n \"\": \"\"\n }\n },\n \"is_not_missing\": {\n \"source\": {\n \"\": \"\"\n }\n },\n \"false_or_missing\": {\n \"source\": {\n \"\": \"\"\n }\n },\n \"true_or_missing\": {\n \"source\": {\n \"\": \"\"\n }\n },\n \"coalesce\": {\n \"sources\": [\n {\n \"\": \"\"\n }\n ]\n },\n \"truncate_time\": {\n \"source\": {\n \"\": \"\"\n },\n \"unit\": \"\",\n \"timezone\": {\n \"\": \"\"\n }\n },\n \"shift_time\": {\n \"source\": {\n \"\": \"\"\n },\n \"amount\": {\n \"\": \"\"\n },\n \"unit\": \"\",\n \"timezone\": {\n \"\": \"\"\n }\n },\n \"any_of_string\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"any_of_number\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"none_of_string\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"none_of_number\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"like_any_of_string\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"like_none_of_string\": {\n \"needle\": {\n \"\": \"\"\n },\n \"haystack\": [\n \"\"\n ]\n },\n \"is_list_member\": {\n \"list\": \"\"\n },\n \"is_not_list_member\": {\n \"list\": \"\"\n }\n }\n },\n \"sequence_condition\": {\n \"sequence\": {\n \"entry_event_filter\": {\n \"combination\": {\n \"\": \"\"\n },\n \"comparison\": {\n \"\": \"\"\n },\n \"path_reference\": {\n \"\": \"\"\n },\n \"string_literal\": {\n \"\": \"\"\n },\n \"number_literal\": {\n \"\": \"\"\n },\n \"boolean_literal\": {\n \"\": \"\"\n },\n \"is_missing\": {\n \"\": \"\"\n },\n \"is_not_missing\": {\n \"\": \"\"\n },\n \"false_or_missing\": {\n \"\": \"\"\n },\n \"true_or_missing\": {\n \"\": \"\"\n },\n \"coalesce\": {\n \"\": \"\"\n },\n \"truncate_time\": {\n \"\": \"\"\n },\n \"shift_time\": {\n \"\": \"\"\n },\n \"any_of_string\": {\n \"\": \"\"\n },\n \"any_of_number\": {\n \"\": \"\"\n },\n \"none_of_string\": {\n \"\": \"\"\n },\n \"none_of_number\": {\n \"\": \"\"\n },\n \"like_any_of_string\": {\n \"\": \"\"\n },\n \"like_none_of_string\": {\n \"\": \"\"\n },\n \"is_list_member\": {\n \"\": \"\"\n },\n \"is_not_list_member\": {\n \"\": \"\"\n }\n },\n \"unique_key_sources\": [\n {\n \"combination\": {\n \"\": \"\"\n },\n \"comparison\": {\n \"\": \"\"\n },\n \"path_reference\": {\n \"\": \"\"\n },\n \"string_literal\": {\n \"\": \"\"\n },\n \"number_literal\": {\n \"\": \"\"\n },\n \"boolean_literal\": {\n \"\": \"\"\n },\n \"is_missing\": {\n \"\": \"\"\n },\n \"is_not_missing\": {\n \"\": \"\"\n },\n \"false_or_missing\": {\n \"\": \"\"\n },\n \"true_or_missing\": {\n \"\": \"\"\n },\n \"coalesce\": {\n \"\": \"\"\n },\n \"truncate_time\": {\n \"\": \"\"\n },\n \"shift_time\": {\n \"\": \"\"\n },\n \"any_of_string\": {\n \"\": \"\"\n },\n \"any_of_number\": {\n \"\": \"\"\n },\n \"none_of_string\": {\n \"\": \"\"\n },\n \"none_of_number\": {\n \"\": \"\"\n },\n \"like_any_of_string\": {\n \"\": \"\"\n },\n \"like_none_of_string\": {\n \"\": \"\"\n },\n \"is_list_member\": {\n \"\": \"\"\n },\n \"is_not_list_member\": {\n \"\": \"\"\n }\n }\n ],\n \"tracked_data\": [\n {\n \"key\": {\n \"\": \"\"\n },\n \"source_path\": \"\",\n \"field_sub_paths\": [\n \"\"\n ]\n }\n ],\n \"max_age_seconds\": \"\",\n \"goal\": {\n \"combination\": {\n \"\": \"\"\n },\n \"event_filter\": {\n \"\": \"\"\n },\n \"sequence_condition\": {\n \"\": \"\"\n },\n \"timeout_source\": {\n \"\": \"\"\n }\n },\n \"disqualifier\": {\n \"combination\": {\n \"\": \"\"\n },\n \"event_filter\": {\n \"\": \"\"\n },\n \"sequence_condition\": {\n \"\": \"\"\n },\n \"timeout_source\": {\n \"\": \"\"\n }\n }\n },\n \"min_count\": \"\",\n \"max_count\": \"\"\n }\n },\n \"collections\": [\n {\n \"key\": \"\",\n \"source\": {\n \"key\": \"\"\n },\n \"narrowed_sub_paths\": [\n \"\"\n ],\n \"unique\": false\n }\n ]\n }\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }