Sign in
latestOpenAPI 3.0.42026-08-213579001013.0 KB

5f993bd211f5

RankingFlow

Updates the configuration of a ranking flow.

patch/flow/ranking/{flowId}/config

Path parameters

flowIdstring required

The ID of the ranking flow to update.

Request body

audienceIdstring nullable

Optional audience ID. When provided, the flow will only serve items to users in this audience. Set to null to remove the audience restriction.

criteriastring

The ranking criteria used to compare items.

startingElointeger

Initial Elo rating for new items.

minResponsesinteger

Minimum number of responses per comparison.

maxResponsesinteger

Maximum number of responses per comparison.

serveResponsesinteger nullable

Number of accepted responses per rapid at which to stop serving. Set to null to remove. Must be less than or equal to MaxResponses when both are set.

serveToResponseRationumber double nullable

Ratio of concurrent serves to max responses. Set to null to remove the limit.

serveTimeoutSecondsinteger nullable

Time in seconds a user has to submit an answer after loading the task. Set to null to use the global default.

targetResponseCountinteger nullable

Target average response count per completed item. Set to null to disable PID control.

pidProportionalGainnumber double

PID proportional gain.

pidIntegralGainnumber double

PID integral gain.

pidDerivativeGainnumber double

PID derivative gain.

pidOutputOffsetnumber double

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

pidMinSessionsPerMinuteinteger

Minimum sessions per minute the PID can set.

pidMaxSessionsPerMinuteinteger

Maximum sessions per minute the PID can set.

pidBatchMode'Total' | 'PerBatch' | 'PerBatchTimeWeighted'

Response

No Content