Contentful Personalization & Analytics
    Preparing search index...

    Interface OptimizationEntryFields<M, L>

    Runtime field values for an Optimization entry.

    interface OptimizationEntryFields<
        M extends ChainModifiers = ChainModifiers,
        L extends LocaleCode = LocaleCode,
    > {
        nt_audience?: AudienceEntry<M, L> | UnresolvedLink<"Entry"> | null;
        nt_config?:
            | {
                components?: (
                    | {
                        baseline: { hidden?: boolean; id: string };
                        type?: "EntryReplacement";
                        variants: { hidden?: boolean; id: string }[];
                    }
                    | {
                        baseline: {
                            value: string
                            | number
                            | boolean
                            | Record<string, JSONType>
                            | null;
                        };
                        key: string;
                        type: "InlineVariable";
                        valueType: "Boolean"
                        | "Number"
                        | "Object"
                        | "String";
                        variants: {
                            value: string | number | boolean | Record<string, JSONType> | null;
                        }[];
                    }
                )[];
                distribution?: number[];
                sticky?: boolean;
                traffic?: number;
            }
            | null;
        nt_description?: string
        | null;
        nt_experience_id: string;
        nt_name: string;
        nt_type: "nt_experiment" | "nt_personalization";
        nt_variants?: (UnresolvedLink<"Entry"> | Entry<EntrySkeletonType, M, L>)[];
    }

    Type Parameters

    Index

    Properties

    nt_audience? nt_config? nt_description? nt_experience_id nt_name nt_type nt_variants?

    Properties

    nt_audience?: AudienceEntry<M, L> | UnresolvedLink<"Entry"> | null
    nt_config?:
        | {
            components?: (
                | {
                    baseline: { hidden?: boolean; id: string };
                    type?: "EntryReplacement";
                    variants: { hidden?: boolean; id: string }[];
                }
                | {
                    baseline: {
                        value: string
                        | number
                        | boolean
                        | Record<string, JSONType>
                        | null;
                    };
                    key: string;
                    type: "InlineVariable";
                    valueType: "Boolean"
                    | "Number"
                    | "Object"
                    | "String";
                    variants: {
                        value: string | number | boolean | Record<string, JSONType> | null;
                    }[];
                }
            )[];
            distribution?: number[];
            sticky?: boolean;
            traffic?: number;
        }
        | null

    Type Declaration

    • {
          components?: (
              | {
                  baseline: { hidden?: boolean; id: string };
                  type?: "EntryReplacement";
                  variants: { hidden?: boolean; id: string }[];
              }
              | {
                  baseline: {
                      value: string
                      | number
                      | boolean
                      | Record<string, JSONType>
                      | null;
                  };
                  key: string;
                  type: "InlineVariable";
                  valueType: "Boolean"
                  | "Number"
                  | "Object"
                  | "String";
                  variants: {
                      value: string | number | boolean | Record<string, JSONType> | null;
                  }[];
              }
          )[];
          distribution?: number[];
          sticky?: boolean;
          traffic?: number;
      }
      • Optionalcomponents?: (
            | {
                baseline: { hidden?: boolean; id: string };
                type?: "EntryReplacement";
                variants: { hidden?: boolean; id: string }[];
            }
            | {
                baseline: {
                    value: string
                    | number
                    | boolean
                    | Record<string, JSONType>
                    | null;
                };
                key: string;
                type: "InlineVariable";
                valueType: "Boolean"
                | "Number"
                | "Object"
                | "String";
                variants: {
                    value: string | number | boolean | Record<string, JSONType> | null;
                }[];
            }
        )[]

        Optimization components that define how content is varied.

      • Optionaldistribution?: number[]

        Variant distribution used for traffic allocation.

      • Optionalsticky?: boolean

        Controls whether the assignment is sticky for a given user.

      • Optionaltraffic?: number

        Percentage of total traffic to include in the optimization.

    • null
    nt_description?: string | null
    nt_experience_id: string
    nt_name: string
    nt_type: "nt_experiment" | "nt_personalization"
    nt_variants?: (UnresolvedLink<"Entry"> | Entry<EntrySkeletonType, M, L>)[]

    Settings

    Member Visibility

    On This Page

    Properties