Web & SaaS Getting Started

Learn more about installing the Pyze Web Smart SDK, initializing it, using timed and custom events.

1. Get a Pyze App Key

See instructions to get a Pyze App Key for your new app

2. Initialize

Add initialization code to all your web pages

Build and Go!

You have enabled all screen flow funnels, loyalty, cohort and churn analysis, Intelligence data explorations, built-in events, auto segmentation, and much more. Use your app with the Pyze SDK and you should see data on growth.pyze.com.

In the following sections, you can add app-defined and timed events.

4. Add events

Add events to your Web or SaaS app. A comprehensive overview of curated, app defined, timed and built-in events is available under Events in the api & events.

Pyze Web and SaaS Developer Center has links to Pyze Documentation and api. Check back frequently for updates and contact us at contact@pyze.com if we can improve this page in anyway or if you have suggestions.

Install

Get Pyze App Key

Get a Pyze App Key (PAK) from growth.pyze.com

1. Login to growth.pyze.com

Every app is uniquely assigned a Pyze App Key (PAK), a 22 character app specific key, which you obtain from growth.pyze.com after logging in with your email and password. If you have not signed up for Pyze, you can Get Pyze here first.

Login to growth.pyze.com

2. Add a new app

  • To add an application to the Pyze platform, begin by selecting Settings from the Navigation Pane.
  • Under the Apps Tab, click the Add App+ button at the top right of the window.
  • Enter the App Name and Appstore URL (if available), Platform (iOS, Android, Web/SaaS, tvOS, watchOS) and select your Timezone.
  • Copy Pyze App Key from your newly added app

Navigate to the newly added app’s settings by ensuring the app you just added is selected from the dropdown menu and copy the Pyze App Key (DmPTFdslRjObk1-ZlXQDVQ in this example).

Initialize

Initialize Pyze for Web and SaaS

Add code in your Web or SaaS app to use the Pyze SDK

The instructions on this page assume you have obtained the Pyze App Key for your project. If not, visit Getting Started Web Guide to get the Pyze App key.

  1. Paste the following JavaScript code between the <head> and </head> tags in every page that uses Pyze Growth Intelligence.
  2. Replace “YOUR_PYZE_APP_KEY” with the Pyze App Key obtained from your growth.pyze.com account.
  3. The JavaScript library provides two global variables: Pyze and PyzeEvents to send data to Pyze Servers.

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    

Remember to replace “YOUR_PYZE_APP_KEY” with the Pyze App key you got from growth.pyze.com

Build and Go!

JSHint - Code quality tool

Using JSHint or other tools and, and getting an error? You can add a comment, for example:

/*global PyzeCuratedEvents */

to the top of the file is causing your JSHint to give a warning. This tells JSHint that this global is defined somewhere else. This is necessary because the Pyze snippet dynamically creates things on the window when your page loads up. If JSHint gives warnings that any of the other Pyze globals aren’t defined, you can use this comment with those global variable names also.

Add Events

See a detailed Events Overview here.

Pyze has made it easy for you to capture events. We support custom and timed events.

Custom Event Handling

We support custom events that can be used to track any event within the web app and can be called with or without attributes. See postCustomEvent and postCustomEventWithAttributes method in the Pyze class (See here).

// Custom Event without Attributes
PyzeEvents.postCustomEvent("Blog Read");

// Custom Event with Attributes
// Create an object with key value pairs of custom attributes and post with postCustomEventWithAttributes

var attributes = {};
attributes["screen"] = "Home";
attributes["seconds spent"] = "50";

PyzeEvents.postCustomEventWithAttributes("Blog Read", attributes);

//Events with Attributes as Object
var attributes = {};
var address = {"city":"Redwood city","state":"CA","phone":{"home":{"area":"408", "prefix":"434", "linenumber":"5234"}}};
attributes["address"] = address;
PyzeEvents.postCustomEventWithAttributes('Blog Read', attributes)

Timed Events

Pyze has made it easy for you to capture duration between events. Pyze supports timed events using following API’s

  • startTimerForEvent - Use this API start timer for perticular event by passing the event name attribute.

  • postTimedEvent - Use this API to end timer and post the event with duration. This API accepts event name attribute. You can also pass attributes as additional parameter as shown in the example below


//Start timer for event
PyzeEvents.startTimerForEvent("Screen Load Time");

//Post timed event. 
//Note : The event name attribute for the `startTimerForEvent` and  `postTimedEvent` should match.
PyzeEvents.postTimedEvent("Screen Load Time");

//Post timed event API when you want to send additional attributes
var customAttributes = {};
customAttributes["device"] = "iMac";
customAttributes["location"] = "CA";
PyzeEvents.postTimedEventWithAttributes("Screen Load Time", customAttributes);

Dimensions

Dimensions are attributes that get attached to all events within a session. This is useful to have a standard set of attributes that change over time, and is simply a helper to accomplish this goal.

Dimensions are any key-value pairs that you attach to the initialize call. Create an object, and modify the initialize call to include this object.


var dimensions = {
  "department": "marketing",
  "role": "associate",
  "alpha": true
}

Pyze.initialize(pyzeAppKey, dimensions);


Any event sent during this session will include the dimensions as attributes

Platform & CMS Integrations

Integrating Pyze with AngularJS

Pyze supports Angular.js, a popular platform for creating dynamic web sites.

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided and paste it in the main html file of your app then replace “YOUR_PYZE_APP_KEY” with the App Key obtained from Pyze in the first line

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • For a single page application, Pyze requires you to call Pyze.postPageView to manually send the page title and pathname when your app changes route/view/location
  • For AngularJS you just need to bind to the $stateChangeSuccess event, which you can do in the run() function, as shown below

     yourAngularApp.run(
         function($rootScope){
             $rootScope.$on('$stateChangeSuccess',function(event, toState, toParams, fromState, fromParams){
                 Pyze.postPageView("PageTitle", "Page URL");
             });
         }
     );
    
  • You’re now ready to begin using Pyze and watch your app grow
  • Learn more about sending events
  • Refer to the Pyze Events API

Integrating Pyze with React

This page is about React.js. React-native for mobile apps is here.

Pyze supports React.js, a popular platform for creating interactive UIs declaratively with component logic written either directly in javascript or in JSX - which adds XML syntax to JavaScript.

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided and paste it in the main html file of your app before the </head> tag, then replace “YOUR_PYZE_APP_KEY” with the App Key obtained from Pyze in the first line

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • For a single page application (using React Router), Pyze requires you to call Pyze.postPageView to manually send the page title and pathname when your app changes route/view/location
  • For React, the Simple React example app code has been modified

     import React from 'react';
     import ReactDOM from 'react-dom';
     import { Router, Route, browserHistory } from 'react-router';
     import Home from './app/screens/Home';
     import User from './app/screens/User';
     import 'bootstrap/dist/css/bootstrap.min.css';
     import './assets/styles.css';
     ReactDOM.render(
       <Router history={browserHistory}>
         <Route path="/" component={Home} />
         <Route path="/:username" component={User} />
       </Router>,
       document.getElementById('container')
     );
    
     browserHistory.listen(function (location) {
         Pyze.postPageView(document.title, location.pathname);
     });
    
  • You’re now ready to begin using Pyze and watch your app grow
  • Learn more about sending events. Refer to the Pyze Events API for sample code.

Integrating Pyze with Squarespace

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided.
  • Log in to your Squarespace site and click on Setting -> Advanced tab under Website -> Code Injection
  • Paste the Pyze Tracking snippet containing your Pyze App Key in the Header section.

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • The Header section will look as follows.

  • You’re now ready to begin using Pyze and watch your app grow.
  • To Track events, add the event handlers, which calls the Pyze Events
  • Pass the id or the class attribute of the element that is involved in the event. Call the JavaScript Custom or Curated event function for tracking. Following is a sample code

     jQuery( document ).ready( function( $ ) {
         $('#BlogPost_Read').click(function() {
             PyzeEvents.postCustomEventWithAttributes("Blog post read", {"Blog Title" : "Understanding web analytics"});
         });
         $('#BlogPost_Commented').hover(function() {
             PyzeEvents.postCustomEventWithAttributes("Blog post commented", {"Commented By" : "User Identifier"});
         });   
         $('#BlogPost_Liked').click( function() {
             PyzeEvents.postCustomEvent("Blog post liked");
         });
     });
    
  • Place the code in the Footer section and start sending events to pyze.

Integrating Pyze with Vue.js

Pyze supports Vue.js, a popular platform for creating dynamic web sites.

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided and paste it in the main html file of your app or the file that holds your routes. Replace “YOUR_PYZE_APP_KEY” with the App Key obtained from Pyze in the first line

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • For a single page application, Pyze requires you to call Pyze.postPageView to manually send the page title and pathname when your app changes route/view/location
  • For Vue.js you just need to call the afterEach method with the router instance and pass the to and from parameters. Call the Pyze.postPageView method with to.name and to.path for the title and path respectively, as shown in the example below

      import Vue from 'vue'
      import Router from 'vue-router'
      import Hello from '@/components/Hello'
      import Page1 from '@/components/Page1'
    
      Vue.use(Router)
    
      const router = new Router({
          routes: [
              {
                  path: '/',
                  name: 'Hello',
                  component: Hello
              },
              {
                  path: '/Page1',
                  name: 'Page1',
                  component: Page1
              }
    
          ]
      })
      export default router
    
      router.afterEach((to, from) => {
          Pyze.postPageView(to.name, to.path);
      })
    

    Pyze has made it easy for you to capture events. We support custom, curated and timed events. (See here).

  • You can call events in your .Vue or .html files as shown in the example below

     <template>
      <div class="hello">
           <h1></h1>
           <button @click="testCustomEvent()">Test postCustomEvent</button>
           <button @click="testCustomEventWithAttributes()">Test postCustomEventWithAttributes</button>
           <a href="#/Page1"> <button >Page1</button></a>
     </div> </template>
     <script>
           export default {
               name: 'hello',
               methods:{
                   testCustomEvent : function(){
                       PyzeEvents.postCustomEvent("Send events to Pyze");
                   },
                   testCustomEventWithAttributes : function(){
                       PyzeEvents.postCustomEventWithAttributes('Sending events with attributes',{'Button Name' : 'Click to send'});
                   }
              },
              data () {
                  return {
                      msg: 'Welcome to Your Vue.js App'
                  }
              }
          }
      </script>
    
  • A sample App for integrating Vue.js with Pyze has been provided here.
  • You’re now ready to begin using Pyze and watch your app grow
  • Learn more about sending events
  • Refer to the Pyze Events API

Integrating Pyze with Wix

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided.
  • Log in to your Wix site and switch to Editor mode
  • Click on the Add Plus icon

  • Select “HTML code” under “more”

  • Paste the Pyze Tracking snippet containing your Pyze App Key

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • Ensure that you replaced “YOUR_PYZE_APP_KEY” with an actual key from growth.pyze.com
  • Make sure that you the HTML snippet to all pages, by switching on “Show on all pages”

  • Save and Publish your Wix Web App!
  • You’re now ready to begin using Pyze and watch your app grow.

Integrating Pyze with WordPress

  • Create an account on Pyze and add your website. Use the Pyze App Key in the tracking code to get started.
  • Copy the Pyze tracking code provided.
  • Log in to your WordPress site and click on Appearances -> Editor on the left navigation bar on the page.

  • Find the header.php file and click on it.:

  • Paste the Pyze Tracking snippet containing your Pyze App Key before the </head> tag

     <!-- Start Pyze Growth Intelligence -->
     <script type="text/javascript">
        var pyzeAppKey="YOUR_PYZE_APP_KEY";
        !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
     </script>
     <!-- End Script Pyze Growth Intelligence -->
    
  • The header.php file should look something like this:

     <?php wp_head(); ?>
         <!-- Start Pyze Growth Intelligence -->
             <script type="text/javascript">
                var pyzeAppKey="YOUR_PYZE_APP_KEY";
                !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
             </script>
         <!-- End Script Pyze Growth Intelligence -->
     </head>
    
  • You’re now ready to begin using Pyze and watch your app grow.
  • To Track events, create a JavaScript file ( e.g. events.js) that contains the event handlers, which calls the Pyze Events
  • Pass the id or the class attribute of the element that is involved in the event. Call the JavaScript Custom or Curated event function for tracking. Following is a sample code

     jQuery( document ).ready( function( $ ) {
         $('#BlogPost_Read').click(function() {
             PyzeEvents.postCustomEventWithAttributes("Blog post read", {"Blog Title" : "Understanding web analytics"});
         });
         $('#BlogPost_Commented').hover(function() {
             PyzeEvents.postCustomEventWithAttributes("Blog post commented", {"Commented By" : "User Identifier"});
         });   
         $('#BlogPost_Liked').click( function() {
             PyzeEvents.postCustomEvent("Blog post liked");
         });
     });
    
  • Place the JavaScript file in the location from where the WordPress site is hosted or Upload it into the “javascript” folder in your theme (e.g. //testwpintegration.com/wp-content/themes/themeName/javascript/)..
  • Include the file in your theme’s header.php file by adding the appropriate path before the closing </head> tag:

     <script type="text/javascript" src="/events.js"></script>
    

Intergation using WordPress Plugins

  • In addition you can use Plugins in WordPress to integrate Pyze.
  • Install the Head and Footer plugin in WordPress and navigate to the Settings -> Header and Footer and click on it.

  • Add the Pyze Tracking code in the Header and the link to the JavaScript file in the footer as shown and click Save

User Profiles

Pyze provides ways to segment data for each logged in user. You can use the following API’s to manage user profiles within your app.

setUserProfile

Use this API to set user profiles.

//Create Pyze Profile Attributes object
var pyzeProfileAttributes = {
   "email_id"        : "xyz@abc.com",
   "date_of_birth"   : "1984-06-01",
   "first_name"      : "John",
   "last_name"       : "Jacobs"
}
//Create Custom Profile Attributes object
var customProfileAttributes = {
   "age"       : 29,
   "pincode"   : "23200",
   "city"      : "XYZ"
}
//Call the setUserProfile API
PyzeIdentity.setUserProfile(userId,pyzeProfileAttributes,customProfileAttributes);

Following are the possible Pyze user profile attributes.

Pyze User Profile Field Name Data Type/Description
background (string) User background, biography or historical data
country (string) Country codes must be sent in the ISO-3166-1 alpha-2 standard.
current_location (object) Format: {“longitude”: -33.991894, “latitude”: 25.243732}
date_of_first_use (date at which the user first used the app) String in ISO 8601 format or in yyyy-MM-dd’T’HH:mm:ss.SSSZ format.
date_of_last_use (date at which the user last used the app) String in ISO 8601 format or in yyyy-MM-dd’T’HH:mm:ss.SSSZ format.
date_of_birth (date of birth) String in format “YYYY-MM-DD”, example: 1984-06-01.
email_id (string) Email Id
email_subscribe (string) Acceptable values are “opt_in” (explicit approval to receive email messages), “opt_out” (explicit denial to email messages), and “subscribed” (neither opted in nor out).
email_hard_bounced Automatically updated when a hard bounce occurs (true or false)
email_spam_reported Automatically updated when a user marks your email as spam, via the ISP (true or false)
facebook_id facebook ID
first_name (string) User’s First name
gender (string) “M”, “F”, “O” (other), “N” (not applicable), “P” (prefer not to say) or “U” (unknown).
home_city (string) User’s Home City
image_url (string) URL of image to be associated with the user
language (string) Require language to be sent in the ISO-639-1 standard.
last_name (string) User’s Last Name
marked_email_as_spam_at (string) Date at which the user’s email was marked as spam. Must be in ISO 8601 format or in yyyy-MM-dd’T’HH:mm:ss.SSSZ format.
phone (string) Phone number
push_subscribe (string) Available values are “opted_in” (explicitly registered to receive push messages), “unsubscribed” (explicitly opted out of push messages), and “subscribed” (neither opted in nor out).
push_tokens Array of objects with app_id and token string. You may optionally provide a device_id for the device this token is associated with, e.g., [{“app_id”: App Identifier, “token”: “abcd”, “device_id”: “optional_field_value”}]. If a device_id is not provided, one will be randomly generated.
time_zone (string) Time Zone’s must be sent as per IANA Time Zone Database (e.g., “America/New_York” or “Eastern Time (US & Canada)”). Only valid values will be respected.
twitter_id Twitter ID

updateUserProfile

To update user profile attributes which are already set, use the following api.

Note : Do not call this api before calling setUserProfile.

//Create Pyze Profile Attributes object
var pyzeProfileAttributes = {
   "email_id"        : "xyz2@abc.com",
   "date_of_birth"   : "1984-07-01",
   "first_name"      : "John M",
   "last_name"       : "Jacobs"
}
//Create Custom Profile Attributes object
var customProfileAttributes = {
   "age"       : 29,
   "pincode"   : "232001",
   "city"      : "XYZ2"
}
//Call the updateUserProfileAttributes API
PyzeIdentity.updateUserProfile(pyzeProfileAttributes,customProfileAttributes);

resetUserProfile

This API is used to reset the user. Call this when you want to remove user from the device.

PyzeIdentity.resetUserProfile(); 

User Privacy

Pyze provides APIs to allow end-users to Opt out of Data Collection and also instruct the Pyze system to forget a user’s data.

setUserOptOut

Allows end-users to opt out from data collection. Opt-out can be toggled true or false.

Pyze.setUserOptOut(true) 

To resume user data collection set value to false

Pyze.setUserOptOut(false) 

deleteUser

Allows end-users to opt out from data collection and delete the user in the Pyze system. We recommend you confirm this action as once a user is deleted, this cannot be undone.

Pyze.deleteUser(true)