SimpleFlow

Creates a simple flow that runs one rapid blueprint over every datapoint of its items.

The blueprint is fixed once the flow has items. Every image collects up to MaxResponses responses; an item ending by time-to-live or stop completes when it averages MinResponses per image.

post/flow/simple

Request body

namestring required

The name of the flow.

maxResponsesinteger nullable

The number of accepted responses per image after which the image stops collecting. Defaults to 5, at least MinResponses.

minResponsesinteger nullable

The minimum average number of accepted responses per image for an item ending by time-to-live or stop to count as completed. Defaults to 3, at least 1.

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.

serveToResponseRationumber double nullable

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

serveTimeoutSecondsinteger nullable

Time in seconds a user has to submit an answer after loading the task. Defaults to 40.

targetResponseCountinteger nullable

Target average response count per completed item for PID rate control. Defaults to MaxResponses times 24, a typical batch.

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' nullable

How PID output maps to campaign rate. Total: direct rate. PerBatch: multiplied by active batch count. PerBatchTimeWeighted: multiplied by time-weighted batch count. Defaults to PerBatch.

drainDurationSecondsinteger nullable

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

Response

OK

flowIdstring required

The ID of the created simple flow.

Changes

Changed in 3 of the 14 revisions of this API.33

    • ●

      removed the request property

      request-property-removed

  • 71d1f82c030f22See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      endpoint added

      endpoint-added