Skip to main content

AudienceService

Script-engine API for reading audience segment definitions and subscriptions. Available in Journey Script steps, Rule script actions, and Script-sourced MeData Definitions.

Functions​

getSegmentDefinitions​

AudienceService.getSegmentDefinitions(): Promise<SegmentDefinition[]>

Retrieves all segment definitions currently available in local storage.

Parameters: None.

getSegmentDefinition​

AudienceService.getSegmentDefinition(
    name: string
): Promise<SegmentDefinition | null>

Retrieves a single segment definition by its name. Returns null if the segment is not found.

Parameters:

  • name: string — Name of the segment definition.

Classes​

SegmentDefinition​

{
    id: string;
    name: string;
    text: string;
    conditionJson: string;
    description?: string | null;
}

SegmentSubscription​

{
    segmentDefinitionId: string;
}

Criteria​

{
    field: string;
    operator: string;
    value: string;
}

Filter​

{
    type?: string | null;
    filters?: Filter[] | null;
    filter?: Filter | null;
    criteria?: Criteria | null;
}