SDK Overview
Welcome to the Pintelly SDK documentation! Pintelly is a unified suite that provides advanced Analytics, user Feedback, and strict Consent management.
Installation
Integrating the Pintelly SDK is incredibly simple. All modules (Analytics, Feedback, Consent) are packaged into a single lightweight bundle.
Just add the following <script> tag to the <head> of your website:
<script type="module" src="https://api.pintelly.com/cdn/feedback-module.es.js" data-backend="https://api.pintelly.com"></script>
Architecture
The SDK is composed of three primary modules which have been developed as independent but heavily interoperable systems:
- Analytics Core: Automatically tracks page views, unique visitors, sessions, and device metrics. Capable of auto-capturing custom button clicks.
- Feedback Widget: A powerful on-site widget allowing users to highlight specific elements, draw on the screen, capture precise screenshots, and submit written feedback.
- Consent Management: A robust, privacy-first module that handles explicit (or implicit) user consent before firing advanced analytics operations.
How it works
Once the script is injected:
- It automatically reads your specific Domain Configuration from the Pintelly backend.
- Based on your Dashboard settings (e.g., whether to enable Scroll Tracking, whether Consent is required, what position the Feedback Button is located), the SDK orchestrates its sub-modules.
- You don't need to write any JavaScript yourself unless you want to use the Advanced Analytics API.
Next Steps
- Explore Analytics for custom event tracking.
- Learn about the Feedback Widget.
- Configure Consent Management for GDPR compliance.
- Dive deep into Advanced Tracking for scroll and cursor data.