Pyze

Pyze object is available globally. Refer to the methods under Pyze documentation to send data.

Initialize

To initialize Pyze please copy the script from here

  • getTimerReference

    getTimerReference method is used to get the start time reference during the start of an event.

    Since

    v1.0.0

    Sample

    Pyze.getTimerReference(function callback(timerReference));

    Parameters

    callback

    Provide a callback function to access the timerReference once it is available from Pyze.

  • getAppInstanceId

    getAppInstanceId method is used to get the app id.

    Since

    v1.0.1

    Sample

    Pyze.getAppInstanceId(function callback(appInstanceId));

    Parameters

    callback

    Provide a callback function to access the appInstanceId once it is available from Pyze.

  • postWebAppVersion

    postWebAppVersion method can be used to send the version of your web application.

    Since

    v1.0.0

    Sample

    var WebAppVersion = "Web App Version";
                                
    Pyze.postWebAppVersion(WebAppVersion);

    Parameters

    WebAppVersion

    Version of your web application.

  • postPageView

    postPageView method can be used to send the Page View information for a Single Page Application. Pyze can track page views internally for static websites. For SPA use this method in the routes to send Page Views.

    Since

    v1.0.1

    Sample

    Pyze.postPageView("PageTitle", "PathName");

    Parameters

    PageTitle

    Title of the current page.

    PathName

    PathName of the page. (location.pathname)

  • User Privacy Methods

  • setUserOptOut

    setUserOptOut method can be used to stop collecting user data.

    Since

    v2.0.1

    Sample

    Pyze.setUserOptOut(true);

    Parameters

    isOptOut

    Boolean value to decide if data tracking should be stopped.

  • deleteUser

    deleteUser method can be used to stop user data collection and delete user data from server.

    Since

    v2.0.1

    Sample

    Pyze.deleteUser(true);

    Parameters

    deleteUser

    Boolean value to decide if data collection should be stopped and delete existing data from the server.