Skip to main content
POST
Preview segment

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Body

application/json

A segment definition the editor has not saved yet, asked about against the roster.

scope
enum<string>
required

Where a segment's membership comes from.

Available options:
rule_based,
manual
match
enum<string>
required

How a condition node combines its clauses.

Available options:
all,
any
clauses
object[]
required
includedWorkerIds
null | string[]
excludedWorkerIds
null | string[]
q
null | string
Maximum string length: 100
cursor
null | integer<int32>
limit
null | integer<int32>

Response

OK

The envelope for a single-resource response: T? ApiResponse<T>.Result on success, otherwise null with one or more IReadOnlyList<ApiError> ApiResponse<T>.Errors.

result
null | object
required

Who an unsaved segment definition would hold.

errors
object[]
required