Audience

Creates a new empty audience.

Changed on
post/audience

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/audience
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

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.

Changes

    • breaking

      request property //////// was restricted to a list of enum values

    • breaking

      the //////// request property type changed from string to no type

    • info

      added the new aa enum value to the request property ////////

    • info

      added the new ab enum value to the request property ////////

    • info

      added the new ae enum value to the request property ////////

    • info

      added the new af enum value to the request property ////////

    • info

      added the new ak enum value to the request property ////////

    • info

      added the new am enum value to the request property ////////

    • info

      added the new an enum value to the request property ////////

    • info

      added the new ar enum value to the request property ////////

    • info

      added the new as enum value to the request property ////////

    • info

      added the new av enum value to the request property ////////

    • info

      added the new ay enum value to the request property ////////

    • info

      added the new az enum value to the request property ////////

    • info

      added the new ba enum value to the request property ////////

    • info

      added the new be enum value to the request property ////////

    • info

      added the new bg enum value to the request property ////////

    • info

      added the new bi enum value to the request property ////////

    • info

      added the new bm enum value to the request property ////////

    • info

      added the new bn enum value to the request property ////////

    • info

      added the new bo enum value to the request property ////////

    • info

      added the new br enum value to the request property ////////

    • info

      added the new bs enum value to the request property ////////

    • info

      added the new ca enum value to the request property ////////

    • info

      added the new ce enum value to the request property ////////

    • info

      added the new ch enum value to the request property ////////

    • info

      added the new co enum value to the request property ////////

    • info

      added the new cr enum value to the request property ////////

    • info

      added the new cs enum value to the request property ////////

    • info

      added the new cu enum value to the request property ////////

    • info

      added the new cv enum value to the request property ////////

    • info

      added the new cy enum value to the request property ////////

    • info

      added the new da enum value to the request property ////////

    • info

      added the new de enum value to the request property ////////

    • info

      added the new dv enum value to the request property ////////

    • info

      added the new dz enum value to the request property ////////

    • info

      added the new ee enum value to the request property ////////

    • info

      added the new el enum value to the request property ////////

    • info

      added the new en enum value to the request property ////////

    • info

      added the new eo enum value to the request property ////////

    • info

      added the new es enum value to the request property ////////

    • info

      added the new et enum value to the request property ////////

    • info

      added the new eu enum value to the request property ////////

    • info

      added the new fa enum value to the request property ////////

    • info

      added the new ff enum value to the request property ////////

    • info

      added the new fi enum value to the request property ////////

    • info

      added the new fj enum value to the request property ////////

    • info

      added the new fo enum value to the request property ////////

    • info

      added the new fr enum value to the request property ////////

    • info

      added the new fy enum value to the request property ////////

    • info

      added the new ga enum value to the request property ////////

    • info

      added the new gd enum value to the request property ////////

    • info

      added the new gl enum value to the request property ////////

    • info

      added the new gn enum value to the request property ////////

    • info

      added the new gu enum value to the request property ////////

    • info

      added the new gv enum value to the request property ////////

    • info

      added the new ha enum value to the request property ////////

    • info

      added the new he enum value to the request property ////////

    • info

      added the new hi enum value to the request property ////////

    • info

      added the new ho enum value to the request property ////////

    • info

      added the new hr enum value to the request property ////////

    • info

      added the new ht enum value to the request property ////////

    • info

      added the new hu enum value to the request property ////////

    • info

      added the new hy enum value to the request property ////////

    • info

      added the new hz enum value to the request property ////////

    • info

      added the new ia enum value to the request property ////////

    • info

      added the new id enum value to the request property ////////

    • info

      added the new ie enum value to the request property ////////

    • info

      added the new ig enum value to the request property ////////

    • info

      added the new ii enum value to the request property ////////

    • info

      added the new ik enum value to the request property ////////

    • info

      added the new io enum value to the request property ////////

    • info

      added the new is enum value to the request property ////////

    • info

      added the new it enum value to the request property ////////

    • info

      added the new iu enum value to the request property ////////

    • info

      added the new ja enum value to the request property ////////

    • info

      added the new jv enum value to the request property ////////

    • info

      added the new ka enum value to the request property ////////

    • info

      added the new kg enum value to the request property ////////

    • info

      added the new ki enum value to the request property ////////

    • info

      added the new kj enum value to the request property ////////

    • info

      added the new kk enum value to the request property ////////

    • info

      added the new kl enum value to the request property ////////

    • info

      added the new km enum value to the request property ////////

    • info

      added the new kn enum value to the request property ////////

    • info

      added the new ko enum value to the request property ////////

    • info

      added the new kr enum value to the request property ////////

    • info

      added the new ks enum value to the request property ////////

    • info

      added the new ku enum value to the request property ////////

    • info

      added the new kv enum value to the request property ////////

    • info

      added the new kw enum value to the request property ////////

    • info

      added the new ky enum value to the request property ////////

    • info

      added the new la enum value to the request property ////////

    • info

      added the new lb enum value to the request property ////////

    • info

      added the new lg enum value to the request property ////////

    • info

      added the new li enum value to the request property ////////

    • info

      added the new ln enum value to the request property ////////

    • info

      added the new lo enum value to the request property ////////

    • info

      added the new lt enum value to the request property ////////

    • info

      added the new lu enum value to the request property ////////

    • info

      added the new lv enum value to the request property ////////

    • info

      added the new mg enum value to the request property ////////

    • info

      added the new mh enum value to the request property ////////

    • info

      added the new mi enum value to the request property ////////

    • info

      added the new mk enum value to the request property ////////

    • info

      added the new ml enum value to the request property ////////

    • info

      added the new mn enum value to the request property ////////

    • info

      added the new mr enum value to the request property ////////

    • info

      added the new ms enum value to the request property ////////

    • info

      added the new mt enum value to the request property ////////

    • info

      added the new my enum value to the request property ////////

    • info

      added the new na enum value to the request property ////////

    • info

      added the new nb enum value to the request property ////////

    • info

      added the new nd enum value to the request property ////////

    • info

      added the new ne enum value to the request property ////////

    • info

      added the new ng enum value to the request property ////////

    • info

      added the new nl enum value to the request property ////////

    • info

      added the new nn enum value to the request property ////////

    • info

      added the new no enum value to the request property ////////

    • info

      added the new nr enum value to the request property ////////

    • info

      added the new nv enum value to the request property ////////

    • info

      added the new ny enum value to the request property ////////

    • info

      added the new oc enum value to the request property ////////

    • info

      added the new oj enum value to the request property ////////

    • info

      added the new om enum value to the request property ////////

    • info

      added the new or enum value to the request property ////////

    • info

      added the new os enum value to the request property ////////

    • info

      added the new pa enum value to the request property ////////

    • info

      added the new pi enum value to the request property ////////

    • info

      added the new pl enum value to the request property ////////

    • info

      added the new ps enum value to the request property ////////

    • info

      added the new pt enum value to the request property ////////

    • info

      added the new qu enum value to the request property ////////

    • info

      added the new rm enum value to the request property ////////

    • info

      added the new rn enum value to the request property ////////

    • info

      added the new ro enum value to the request property ////////

    • info

      added the new ru enum value to the request property ////////

    • info

      added the new rw enum value to the request property ////////

    • info

      added the new sa enum value to the request property ////////

    • info

      added the new sc enum value to the request property ////////

    • info

      added the new sd enum value to the request property ////////

    • info

      added the new se enum value to the request property ////////

    • info

      added the new sg enum value to the request property ////////

    • info

      added the new sh enum value to the request property ////////

    • info

      added the new si enum value to the request property ////////

    • info

      added the new sk enum value to the request property ////////

    • info

      added the new sl enum value to the request property ////////

    • info

      added the new sm enum value to the request property ////////

    • info

      added the new sn enum value to the request property ////////

    • info

      added the new so enum value to the request property ////////

    • info

      added the new sq enum value to the request property ////////

    • info

      added the new sr enum value to the request property ////////

    • info

      added the new ss enum value to the request property ////////

    • info

      added the new st enum value to the request property ////////

    • info

      added the new su enum value to the request property ////////

    • info

      added the new sv enum value to the request property ////////

    • info

      added the new sw enum value to the request property ////////

    • info

      added the new ta enum value to the request property ////////

    • info

      added the new te enum value to the request property ////////

    • info

      added the new tg enum value to the request property ////////

    • info

      added the new th enum value to the request property ////////

    • info

      added the new ti enum value to the request property ////////

    • info

      added the new tk enum value to the request property ////////

    • info

      added the new tl enum value to the request property ////////

    • info

      added the new tn enum value to the request property ////////

    • info

      added the new to enum value to the request property ////////

    • info

      added the new tr enum value to the request property ////////

    • info

      added the new ts enum value to the request property ////////

    • info

      added the new tt enum value to the request property ////////

    • info

      added the new tw enum value to the request property ////////

    • info

      added the new ty enum value to the request property ////////

    • info

      added the new ug enum value to the request property ////////

    • info

      added the new uk enum value to the request property ////////

    • info

      added the new ur enum value to the request property ////////

    • info

      added the new uz enum value to the request property ////////

    • info

      added the new ve enum value to the request property ////////

    • info

      added the new vi enum value to the request property ////////

    • info

      added the new vo enum value to the request property ////////

    • info

      added the new wa enum value to the request property ////////

    • info

      added the new wo enum value to the request property ////////

    • info

      added the new xh enum value to the request property ////////

    • info

      added the new yi enum value to the request property ////////

    • info

      added the new yo enum value to the request property ////////

    • info

      added the new za enum value to the request property ////////

    • info

      added the new zh enum value to the request property ////////

    • info

      added the new zu enum value to the request property ////////

    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect