v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
RankingFlow

Creates a new ranking flow.

post/flow/ranking

Request body

namestring required

The name of the ranking flow.

criteriastring required

The ranking criteria used to compare items.

audienceIdstring nullable

Optional audience ID. When provided, the flow will only be served to users in this audience.

validationSetIdstring nullable

Optional ID of the validation set to use.

startingElointeger nullable

Initial Elo rating for new items. Defaults to 1200.

maxResponsesinteger nullable

Maximum number of responses per comparison.

serveResponsesinteger nullable

Number of accepted responses per rapid at which to stop serving. When set, must be less than or equal to MaxResponses. Null defaults to MaxResponses.

serveToResponseRationumber double nullable

Ratio of concurrent serves to max responses. When set, limits serving to avoid over-collection.

serveTimeoutSecondsinteger nullable

Time in seconds a user has to submit an answer after loading the task. When set, overrides the global default.

minResponsesinteger nullable

Minimum number of responses per comparison. Defaults to 20.

targetResponseCountinteger nullable

Target average response count per completed item. Enables PID control when set.

pidProportionalGainnumber double nullable

PID proportional gain. Defaults to 0.

pidIntegralGainnumber double nullable

PID integral gain. Defaults to 0.003.

pidDerivativeGainnumber double nullable

PID derivative gain. Defaults to 0.

pidOutputOffsetnumber double nullable

Constant offset added to the PID output before clamping, shifting the controller's operating point. Defaults to 25.

pidMinSessionsPerMinuteinteger nullable

Minimum sessions per minute the PID can set. Defaults to 20.

pidMaxSessionsPerMinuteinteger nullable

Maximum sessions per minute the PID can set. Defaults to 50.

pidBatchMode'Total' | 'PerBatch' | 'PerBatchTimeWeighted'
drainDurationSecondsinteger nullable

Duration in seconds for draining flow items. Defaults to 40.

Response

OK

flowIdstring required

The ID of the created ranking flow.