Sign in

v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB
Segments

Get Segment

This endpoint returns the metadata of a Segment identified by the segmentId.

get/v1/segments/{segmentId}

Path parameters

segmentIdstring uuid required

The identifier of the Segment.

Response

When everything is ok, the config data returned.

segmentIdstring uuid required

Identifier of the Segment.

namestring required

Name of the Segment.

descriptionstring nullable required

Description of the Segment.

creatorEmailstring nullable required

The email of the user who created the Segment.

creatorFullNamestring nullable required

The name of the user who created the Segment.

createdAtstring date-time required

The date and time when the Segment was created.

lastUpdaterEmailstring nullable required

The email of the user who last updated the Segment.

lastUpdaterFullNamestring nullable required

The name of the user who last updated the Segment.

updatedAtstring date-time required

The date and time when the Segment was last updated.

comparisonAttributestring required

The user's attribute the evaluation process must take into account.

comparator'isOneOf' | 'isNotOneOf' | 'contains' | 'doesNotContain' | 'semVerIsOneOf' | 'semVerIsNotOneOf' | 'semVerLess' | 'semVerLessOrEquals' | 'semVerGreater' | 'semVerGreaterOrEquals' | 'numberEquals' | 'numberDoesNotEqual' | 'numberLess' | 'numberLessOrEquals' | 'numberGreater' | 'numberGreaterOrEquals' | 'sensitiveIsOneOf' | 'sensitiveIsNotOneOf' required

The comparison operator the evaluation process must use when it compares the given user attribute's value with the comparison value.

comparisonValuestring required

The value to compare with the given user attribute's value.