@metrixorg/websdk-metrix-test NPM

Getting Started

These instructions will get you setup to use WebSDK in your project.

install using npm:

npm install @metrixorg/websdk-test

Or add within <script> tag: Place the following <script> inside <head> of your project.

<script src="" type="text/javascript"  crossorigin="anonymous"></script>

Configuration

Initialize Metrix at the start of your application by calling the following method:

import Metrix from '@metrixorg/websdk-metrix-test';

const metrix = new Metrix();

metrix.init('APP_ID', 'API_KEY')

Note: Use Metrix as a singleton instance in your project.

APP_ID: Your application identifier. You can find this id in your Metrix dashboard under Settings > App Info.

API_KEY: You can find this key in dashboard.

API

newEvent

Each interaction that the user has with your application can be introduced as an Event in your dashboard and application in order for Metrix to collect and present its statistics.

newEvent(slug: string, customAttributes: {[key: string]: string}): void

name	type	description
slug	`string`	generated event slug in dashboard
customAttributes	`{[key: string: string]}`	any custom attribute related to event

You can use Metrix to track any events in your application. Suppose you want to track every tap on a button. You would have to create a new event in the Events Management section of your dashboard (Settings > Events > Add event) and retrieve the generated slug for the event. The slug is to be used in the application code to send the event to Metrix library. So In your button's onClick method you could then invoke the Metrix newEvent method providing the event slug and optionally some attributes named customAttributes related to the event like the following:

// Send simple event
metrix.newEvent('EVENT_SLUG');

// Send an event with custom attribute
const attributes = {};
attributes['first_name'] = 'Ali';
attributes['last_name'] = 'Bagheri';
attributes['manufacturer'] = 'Nike';
attributes['product_name'] = 'shirt';
attributes['type'] = 'sport';
attributes['size'] = 'large';

metrix.newEvent('EVENT_SLUG', attributes);

setCustomAttribute

setCustomAttribute(key: string, value: string) : void

Parameter Name	Parameter Type	description
key	`string`	key of custom attribute
value	`string`	value of custom attribute

setFirstName

you can use metrix WebSDK to store user session visiting your application. By this method you can send user first name to metrix library.

setFirstName(firstName: string) : void

Parameter Name	Parameter Type	description
firstName	`string`	user first name

setLastName

By this method you can send user last name to metrix library.

setLastName(lastName: string) : void

Parameter Name	Parameter Type	description
lastName	`string`	user first name

setEmail

By this method you can send user email to metrix library.

setEmail(email: string) : void

Parameter Name	Parameter Type	description
email	`string`	user email

setHashedEmail

By this method you can send user hashed email to metrix library.

setHashedEmail(hashedEmail: string) : void

Parameter Name	Parameter Type	description
hashedEmail	`string`	user hashed email

setPhoneNumber

By this method you can send user phone number to metrix library.

setPhoneNumber(phoneNumber: string) : void

Parameter Name	Parameter Type	description
phoneNumber	`string`	user phone number

setHashedPhoneNumber

By this method you can send user phone number as hashed phone number to metrix library.

setHashedPhoneNumber(hashedPhoneNumber: string) : void

Parameter Name	Parameter Type	description
hashedPhoneNumber	`string`	user hashed phone number

setCountry

By this method you can send user country to metrix library.

setCountry(country: string) : void

Parameter Name	Parameter Type	description
country	`string`	user country

setCity

By this method you can send user city to metrix library.

setCity(city: string) : void

Parameter Name	Parameter Type	description
city	`string`	user city

setRegion

By this method you can send user city to metrix library.

setRegion(region: string) : void

Parameter Name	Parameter Type	description
region	`string`	user region

setLocality

By this method you can send user locality to metrix library.

setLocality(locality: string) : void

Parameter Name	Parameter Type	description
locality	`string`	user locality

setGender

By this method you can send user gender to metrix library.

setGender(gender: string) : void

Parameter Name	Parameter Type	description
gender	`string`	user gender

setBirthday

By this method you can send user birthday date to metrix library.

setBirthday(birthday: string) : void

Parameter Name	Parameter Type	description
birthday	`string`	user birthday

Additional Features

Session Tracking

Metrix, tracks sessions visiting your website/application and collect data from their activity. types of activity are:

duration: session duration time, the time that user is active on your website/application tab by specified session.
note: The time when the user leaves your website/application tab is not counted as session duration. Therefore, when the user returns to your website/application tab, the duration of the session is calculated from that moment.
activityFlow: array of pages address of your website/application that the user has viewed.