Experiment JS Client Documentation - v1.21.2
    Preparing search index...

    Type Alias ExperimentUser

    Defines a user context for evaluation. device_id and user_id are used for identity resolution. All other predefined fields and user properties are used for rule based user targeting.

    type ExperimentUser = {
        browser?: string;
        carrier?: string;
        city?: string;
        cookie?: Record<string, string>;
        country?: string;
        device_category?:
            | "mobile"
            | "tablet"
            | "desktop"
            | "wearable"
            | "console"
            | "smarttv"
            | "embedded";
        device_id?: string;
        device_model?: string;
        dma?: string;
        first_seen?: string;
        group_properties?: {
            [groupType: string]: {
                [groupName: string]: {
                    [propertyName: string]: | string
                    | number
                    | boolean
                    | (string | number | boolean)[];
                };
            };
        };
        groups?: { [groupType: string]: string[] };
        ip_address?: string;
        landing_url?: string;
        language?: string;
        library?: string;
        os?: string;
        persisted_url_param?: Record<string, string | string[]>;
        platform?: string;
        referring_url?: string;
        region?: string;
        url_param?: Record<string, string | string[]>;
        user_agent?: string;
        user_id?: string;
        user_properties?: {
            [propertyName: string]:
                | string
                | number
                | boolean
                | (string | number | boolean)[];
        };
        version?: string;
    }
    Index

    Properties

    browser? carrier? city? cookie? country? device_category? device_id? device_model? dma? first_seen? group_properties? groups? ip_address? landing_url? language? library? os? persisted_url_param? platform? referring_url? region? url_param? user_agent? user_id? user_properties? version?

    Properties
    browser?: string

    The browser used, auto populated via a ExperimentUserProvider, can be manually overridden

    carrier?: string

    Predefined field, can be manually provided

    city?: string

    Predefined field, can be manually provided

    cookie?: Record<string, string>

    The cookies, auto populated via a ExperimentUserProvider, can be manually overridden Local evaluation only. Stripped before remote evaluation.

    country?: string

    Predefined field, can be manually provided

    device_category?:
        | "mobile"
        | "tablet"
        | "desktop"
        | "wearable"
        | "console"
        | "smarttv"
        | "embedded"

    The device category of the device, auto populated via a ExperimentUserProvider, can be manually overridden

    device_id?: string

    Device ID for associating with an identity in Amplitude

    device_model?: string

    Predefined field, auto populated via a ExperimentUserProvider or can be manually provided

    dma?: string

    Predefined field, can be manually provided

    first_seen?: string

    The time first saw this user, stored in local storage, can be manually overridden

    group_properties?: {
        [groupType: string]: {
            [groupName: string]: {
                [propertyName: string]:
                    | string
                    | number
                    | boolean
                    | (string | number | boolean)[];
            };
        };
    }
    groups?: { [groupType: string]: string[] }
    ip_address?: string

    Predefined field, can be manually provided

    landing_url?: string

    The landing page of the user, the first page that this user sees for this deployment Auto populated via a ExperimentUserProvider, can be manually overridden

    language?: string

    Predefined field, auto populated via a ExperimentUserProvider or can be manually provided

    library?: string

    Predefined field, auto populated, can be manually overridden

    os?: string

    Predefined field, auto populated via a ExperimentUserProvider or can be manually provided

    persisted_url_param?: Record<string, string | string[]>

    Persisted parameters parsed from the URL and stored in local storage.

    platform?: string

    Predefined field, auto populated via a ExperimentUserProvider or can be manually provided

    referring_url?: string

    The referring url that redirected to this page, auto populated via a ExperimentUserProvider, can be manually overridden

    region?: string

    Predefined field, can be manually provided

    url_param?: Record<string, string | string[]>

    The url params of the page, for one param, value is string if single value, array of string if multiple values Auto populated via a ExperimentUserProvider, can be manually overridden

    user_agent?: string

    The user agent string.

    user_id?: string

    User ID for associating with an identity in Amplitude

    user_properties?: {
        [propertyName: string]:
            | string
            | number
            | boolean
            | (string | number | boolean)[];
    }

    Custom user properties

    version?: string

    Predefined field, auto populated via a ExperimentUserProvider or can be manually provided

    Settings
    Member Visibility

    On This Page
    Properties