v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Audience

Creates a new empty audience.

post/audience

Request body

namestring required

The name to give the newly created audience.

descriptionstring nullable

An optional markdown-supported description of the audience's purpose.

minimumSizeForActivationinteger nullable

The minimum number of users required for an audience to be activated.

maxDistillingResponsesinteger nullable

Maximum responses before user exits the distilling campaign. Defaults to 10. Set to null to disable this exit condition.

dropMinResponsesinteger nullable

Minimum responses before the drop score check applies. Users need at least this many responses before they can be kicked out for low score. Defaults to 3. Set to null to apply drop score check from the first response.

dropScorenumber double nullable

Score floor - users below this score exit the distilling campaign (only after completing DropMinResponses). Defaults to 0.2. Set to null to disable this exit condition.

isDistillingCampaignStickyboolean

Whether the distilling campaign should be sticky (users stay until filters don't match). Defaults to true (Temporary sticky).

maxDistillingSessionsinteger nullable

Maximum sessions (rapid retrievals) before user exits the distilling campaign. Defaults to null (disabled). Set to a value to enable session-based exit condition.

inactivityDropDaysinteger nullable

Number of days of inactivity before a distilling user is dropped. Defaults to null (disabled).

minSubmissionRatenumber double nullable

Minimum submission rate (responses / sessions) before a user is dropped. Defaults to null (disabled).

minSessionsForSubmissionRateinteger nullable

Minimum number of sessions before the submission rate check applies. Defaults to null (applies from first session).

minSubmissionRateGraduatednumber double nullable

Minimum submission rate for graduated users. If null, MinSubmissionRate applies to graduated users. Set a lower value to be more lenient with graduated users.

distillingRetrievalMode'Random' | 'Shuffled' | 'Sequential'
minDistillingForGlobalBoostinteger nullable

Minimum distilling users before disabling global boost. Defaults to 200. Admin-only override.

minGraduatedForDistillingBoostinteger nullable

Minimum graduated users before disabling distilling boost. Defaults to 100. Admin-only override.

Response

OK

audienceIdstring required

The unique identifier of the newly created audience.