Contentful Personalization & Analytics
    Preparing search index...

    Interface FetchOptimizedEntryOptions

    Options for CoreBase.fetchOptimizedEntry.

    interface FetchOptimizedEntryOptions {
        query?: ContentfulEntryQuery;
        selectedOptimizations?: {
            experienceId: string;
            sticky?: boolean;
            variantIndex: number;
            variants: Record<string, string>;
        }[];
    }
    Index

    Properties

    query? selectedOptimizations?

    Properties

    query?: ContentfulEntryQuery

    Per-call Contentful query overrides when fetching an entry ID string.

    selectedOptimizations?: {
        experienceId: string;
        sticky?: boolean;
        variantIndex: number;
        variants: Record<string, string>;
    }[]

    Selected optimizations used for personalized entry resolution.

    Type Declaration

    • experienceId: string

      Identifier of the personalization or experiment experience.

    • Optionalsticky?: boolean

      Indicates whether this optimization selection is sticky for the user.

      false

      Reuse sticky selections on subsequent requests for the same user rather than re-allocating a new variant.

    • variantIndex: number

      Index of the selected variant within the experience configuration.

      Typically corresponds to the index of the selected OptimizationConfig entry.

    • variants: Record<string, string>

      Mapping of baseline entry IDs to their selected variant entry IDs.

      The keys are component identifiers and the values are the identifiers of the selected variant for that component.

    Settings

    Member Visibility

    On This Page

    Properties