v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Audience

Returns the audience with the specified id.

Accepts the id of a filtered audience too. In that case the response describes the underlying base audience, with filter set to the filter applied on top of it.

get/audience/{audienceId}

Path parameters

audienceIdstring required

The unique identifier of the audience.

Response

OK

idstring required

The unique identifier of the audience.

baseAudienceIdstring required

The audience that backs this entry. Equals id for a regular audience; for a filtered audience it points to the audience the filter is applied on top of.

namestring required

The name of the audience.

descriptionstring nullable

The markdown-supported description of the audience.

status'Created' | 'Pending' | 'Recruiting' | 'Ready' required
qualifiedUserCountinteger required

The number of users that have qualified for this audience.

logostring nullable

The URL of the audience logo, if any.

createdAtstring date-time required

The timestamp when the audience was created.

ownerIdstring uuid required

The unique identifier of the audience owner.

ownerMailstring required

The email of the audience owner.

organizationIdstring required

The id of the organization that owns the entity.

isPublicboolean required

Whether the audience is publicly visible.

isDistillingboolean required

Whether the audience is currently distilling users.

distillingCampaignIdstring required

The id of the distilling campaign associated with the audience.

minGraduatedForDistillingBoostinteger nullable

Minimum graduated users before disabling distilling boost.

minDistillingForGlobalBoostinteger nullable

Minimum distilling users before disabling global boost.

maxDistillingResponsesinteger nullable

Maximum responses before user exits the distilling campaign.

dropMinResponsesinteger nullable

Minimum responses before the drop score check applies.

dropScorenumber double nullable

Score floor - users below this score exit the distilling campaign.

maxDistillingSessionsinteger nullable

Maximum sessions before user exits the distilling campaign.

inactivityDropDaysinteger nullable

Number of days of inactivity before a distilling user is dropped.

minSubmissionRatenumber double nullable

Minimum submission rate before a user is dropped.

minSessionsForSubmissionRateinteger nullable

Minimum number of sessions before the submission rate check applies.

minSubmissionRateGraduatednumber double nullable

Minimum submission rate for graduated users.

distillingRetrievalMode'Random' | 'Shuffled' | 'Sequential' required
boostLevel'None' | 'Stable' | 'Distilling' | 'Global' required
randomAdmissionProbabilitynumber double nullable

The probability of admitting a random user to the audience.

healthnumber double nullable

The health score of the audience.

graduatedinteger

The number of graduated users.

droppedinteger

The number of dropped users.