PulseTrack

English

Español

English

Español

Appearance

Frequently Asked Questions (FAQ) ​

Installation ​

What do I need to start using the SDK? ​

  • Modern browser or Node.js 16+
  • (Optional) npm or yarn if using the npm package
  • Basic knowledge of JavaScript/TypeScript

How do I install the SDK in my project? ​

You have two main options:

Option 1: Using CDN

html
<script src="https://cdn.jsdelivr.net/gh/Chikavi1/pulsetrack@master/dist/pulsetrack.umd.min.js"></script>

Option 2: Using npm/yarn

bash
npm install pulsetrack
# or
yarn add pulsetrack

Configuration ​

How do I initialize the SDK? ​

With CDN:

javascript
PulseTrack.init({
  businessId: 'your-business-id'
});

With ES modules:

javascript
import { PulseTrack } from 'pulsetrack';

PulseTrack.init({
  businessId: 'your-business-id'
});

Feedback Widget ​

How do I customize the feedback button? ​

You can customize the feedback widget as follows:

typescript
const feedback = new Feedback({
  position: 'bottom-right',  // Button position
  themeColor: '#4f46e5',     // Primary color
  buttonText: 'Send Feedback',
  autoOpen: false
});

Can I enable screenshots in feedback? ​

Yes, you can enable screenshots with the following configuration:

typescript
const feedback = new Feedback({
  // ...other configurations
  screenshot: {
    enabled: true,
    allowEdit: true,
    quality: 0.8
  }
});

Sessions ​

How do I start session tracking? ​

typescript
const session = new SessionTracker({
  appId: 'your-app-id',
  sessionTimeout: 30, // minutes of inactivity
  recordClicks: true,
  recordScroll: true
});

session.start();

How do I add additional information to a session? ​

You can add custom tags:

typescript
session.addTag('userRole', 'premium');

Errors ​

How do I handle uncaught errors? ​

You can set up a global error handler:

typescript
window.onerror = function(message, source, lineno, colno, error) {
  session.addErrorTag({
    message: message.toString(),
    source,
    line: lineno,
    column: colno,
    stack: error?.stack
  });
  return false;
};

Support ​

Where can I find additional help? ​

How do I report an issue or request a feature? ​

You can create an issue in our GitHub repository.

Security ​

What security measures does the SDK include? ​

  • Patches for known vulnerabilities
  • Encryption improvements
  • Critical dependency updates

How is sensitive data handled? ​

The SDK includes features to exclude or mask sensitive information. Make sure to properly configure the privacy options according to your needs.

Last updated: January 2024