Contentful Personalization & Analytics
    Preparing search index...

    Interface ExperienceApiClientRequestOptions

    Options that control how requests to the Experience API are handled.

    interface ExperienceApiClientRequestOptions {
        enabledFeatures?: Feature[];
        ip?: string;
        locale?: string;
        plainText?: boolean;
        preflight?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enabledFeatures? ip? locale? plainText? preflight?

    Properties

    enabledFeatures?: Feature[]

    Enabled features (for example, "ip-enrichment") which the API should use for this request.

    When omitted, a default set of features may be applied.

    ip?: string

    IP address to override the API behavior for IP analysis.

    Commonly used in ESR or SSR environments, as the API would otherwise use the server IP.

    locale?: string

    Locale used to translate location.city and location.country.

    When omitted, a server-side default may be used.

    plainText?: boolean

    When true, sends performance-critical endpoints in plain text.

    The Ninetailed API accepts certain endpoints in plain text to avoid CORS preflight requests, which can improve performance in browser environments.

    preflight?: boolean

    When true, instructs the API to aggregate a new profile state but not store it.

    This is commonly used in ESR or SSR environments where you want to preview the result without persisting changes.

    Settings

    Member Visibility

    On This Page

    Properties