SimpleFlow

Updates the configuration of a simple flow. Changing the blueprint once the flow has items returns 409 Conflict.

patch/flow/simple/{flowId}

Path parameters

flowIdstring required

The ID of the simple 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.

maxResponsesinteger

The number of accepted responses per image after which the image stops collecting. At least MinResponses.

minResponsesinteger

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

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

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