advanced
    • 4 Minutes to read
    • Dark
      Light

    advanced

    • Dark
      Light

    Article summary

    Overview

    Value

    Notes

    Data type

    Default value

    Required

    secureCookie

    When set to true , the "secure" flag will be added to all client-side Mapp Intelligence cookies.

    Boolean

    false

    -

    optOutName

    Defines an alternative name for the Mapp Intelligence opt-out cookie.

    String

    webtrekkOptOut

    -

    requestObfuscation

    When set to true the option, the pixel randomly mixes the parameters of the request to make it harder for adblockers to identify and block Mapp Intelligence track requests.

    Boolean

    false

    -

    forceOldEverId

    When set to true the ever IDs from previous pixel versions will be migrated and used.

    Boolean

    false

    -

    execCDB

    Activates/deactivates the Cross Device Bridge.

    Boolean

    true

    -

    useCDBCache

    Activates/deactivates the image cache for the Cross Device Bridge.

    Boolean

    false

    -

    sendViaSDK

    Activates/deactivates the Web-to-App tracking functionality, e.g., when tracking web views in mobile applications.

    Boolean

    false

    -

    sendViaServer.activated

    Activates/deactivates the pixel configuration to support server-to-server tracking. This can be used in connection with Mapp's server-to-server libraries.

    Boolean

    false

    -

    sendViaServer.serverDomain

    Indicates the domain where the server-to-server library is hosted. If left empty, the pixel sends the requests to the Mapp Intelligence track server directly and not to the server-to-server library.

    String

    -

    -

    sendViaServer.serverPath

    Indicates the path where the server-to-server library is saved on your server. If left empty, the requests are sent directly to the Mapp Intelligence track server and not to the server-to-server library.

    String

    -

    -

    sendViaServer.droppedRequests

    Discard pixel requests:

    • 0: None

    • 1: Orders

    • 2: Products

    • 3: All page requests

    Indicate the type of requests that have to be discarded by the pixel. It is possible to narrow the requests further if you indicate specific content IDs under "Discard specific requests".

    Number

    -

    -

    sendViaServer.blacklist

    Indicates specific page requests that need to be discarded by the pixel. Please note:

    • Suppose you would like only to discard a specific order or product request. In that case, you need to set discard pixel requests to orders or products, respectively, and indicate the particular content ID of the order or product to be dumped here.

    • If you like only to discard a specific page request, you need to set discard pixel requests to all page requests and indicate the content ID to be dumped here.

    String[] / RegExp[]

    -

    -

    useHashForDefaultPageName

    Includes the URL hash in the default page name.

    Boolean

    false

    -

    useParamsForDefaultPageName

    Includes specific URL parameter(s) in the default page name.

    String[]

    []

    -

    requestQueue.activated

    When set to true, the offline tracking queue functionality is activated.

    Boolean

    false

    -

    requestQueue.ttl

    Specifies the maximum time a request can remain in the queue until it is deleted.

    Number

    5 * 60 * 1000

    -

    requestQueue.resendInterval

    Defines the millisecond interval between resending requests if an error occurred during send out or a request could not have been sent.

    Number

    5 * 1000

    -

    requestQueue.size

    Defines the maximum number of requests saved in the queue.

    Number

    100

    -

    requestQueue.retries

    Specifies the maximum number of retries before the request is deleted or no more requests are sent for the entire session. -1 specifies an unlimited number of retries.

    Number

    -1

    -

    requestQueue.retriesOption

    Specifies the option of retries:

    • 1: The limit is set for each request

    • 2: The limit is set for the entire session

    Number

    1

    -

    requestLimit.activated

    Activates/deactivates the request limitation. The maximum number of permissible requests is limited to reduce the risk of sending many requests in error. This could be caused by an incorrect pixel implementation or by bot traffic. As soon as the standard limit of 1000 requests (pages and actions) every 30 minutes is exceeded, no further requests are sent by the pixel for the remaining time.

    Boolean

    false

    -

    requestLimit.amount

    The maximum number of requests permitted to be sent in the specified time period.

    Number

    1000

    -

    requestLimit.duration

    Time interval in seconds for sending the maximum X number of requests.

    Number

    30*60

    -

    userIdentification.enableAnonymousFunction

    Enable if you want to allow users to opt out of user-identifiable cookies and parameters when tracking. By default, this function will still track with user-identifiable cookies, but users can opt-out using the respective function.

    Boolean

    false

    -

    userIdentification.anonymousCookieName

    An alternative name for the anonymous tracking cookie. If you do not provide a name, miCookieOptOut will be used.

    String

    miCookieOptOut

    -

    userIdentification.anonymousOptIn

    Enable if you want to use anonymous tracking by default. Enabling this option will not set any user-identifiable cookie until the user actively agrees to its usage.

    Boolean

    false

    -

    userIdentification.suppressParameter

    It can exclude additional parameters if the user sets the user-identifiable opt-out cookie. Please indicate the respective parameters in the array.

    String[]

    []

    -

    userIdentification.temporarySessionId

    In order to keep the session and the user during a single session, we offer the possibility to set a temporary session ID that keeps the session together but is not permanently stored on a device.

    String

    -

    -

    userIdentification.saveTemporarySessionId

    If you enable this option, the temporary session ID will be stored in the session storage, so you don't have to set it on every page

    Boolean

    false

    -

    Implementation Example

    import { WebtrekkSmartPixelReact, WebtrekkAdvancedData } from "@webtrekk-smart-pixel/react";
    import { WebtrekkSmartPixelReact, WebtrekkAdvancedData } from "@webtrekk-smart-pixel/next";
    WebtrekkSmartPixelReact.advanced({
        secureCookie: false,
        optOutName: "webtrekkOptOut",
        requestObfuscation: false,
        forceOldEverId: false,
        execCDB: true,
        useCDBCache: false,
        sendViaSDK: false,
        sendViaServer: {
            activated: false,
            serverDomain: '',
            serverPath: '',
            droppedRequests: 0,
            blacklist: [/.+/]
        },
        useHashForDefaultPageName: true,
        useParamsForDefaultPageName: ['param1', 'param2'],
        requestQueue: {
            activated: false,
            ttl: 5 * 60 * 1000,
            resendInterval: 5 * 1000,
            size: 100,
            retries: -1,
            retriesOption: 1
        },
        requestLimit: {
            activated: false,
            amount: 1000,
            duration: 30 * 60
        },
        userIdentification: {
            enableAnonymousFunction: false,
            anonymousOptIn: 'miCookieOptOut',
            anonymousCookieName: false,
            suppressParameter: []
        }
    });
    render()
    {
        return (
            <div>
                <WebtrekkAdvancedData
                    secureCookie={ false }
                    optOutName="webtrekkOptOut"
                    requestObfuscation={ false }
                    forceOldEverId={ false }
                    execCDB={ true }
                    useCDBCache={ false }
                    sendViaSDK: { false },
                    sendViaServer: { {
                        activated: false,
                        serverDomain: '',
                        serverPath: '',
                        droppedRequests: 0,
                        blacklist: [/.+/]
                    } },
                    useHashForDefaultPageName: { true },
                    useParamsForDefaultPageName: { ['param1', 'param2'] },
                    requestQueue={ {
                        activated: false,
                        ttl: 5 * 60 * 1000,
                        resendInterval: 5 * 1000,
                        size: 100,
                        retries: -1,
                        retriesOption: 1
                    } },
                    requestLimit: { {
                        activated: false,
                        amount: 1000,
                        duration: 30 * 60
                    } },
                    userIdentification: { {
                        enableAnonymousFunction: false,
                        anonymousOptIn: 'miCookieOptOut',
                        anonymousCookieName: false,
                        suppressParameter: []
                    } }
                />
            </div>
        );
    }


    Was this article helpful?

    What's Next