Web Feedback JavaScript APIs Overview
The Web Feedback JavaScript APIs provide a programmatic interface for controlling Qualtrics Website Feedback (Site Intercept) on your web pages. Unlike a traditional SDK, these APIs are built into the Website Feedback deployment snippet—no separate install is required. When you add the Qualtrics deployment code to your site, QSI.API and related objects become available for use.
What's Included
The APIs are composed of three main areas:
| API | Purpose |
|---|---|
| QSI.API | Core API for loading, running, and unloading intercepts. Use this to control when and how intercepts appear on your pages. |
| QSI.API.Events | Track user actions (e.g., button clicks, page views) and use them in targeting logic or as embedded data. |
| QSI.API.SessionRecording | Control Digital Experience Analytics (DXA) Session Recording—start, stop, and pause recording for compliance with consent workflows. |
When to Use These APIs
- Single Page Applications (SPAs) – Load and unload intercepts on route changes without full page reloads.
- Conditional loading – Load intercepts only when certain tabs or sections are viewed.
- Consent workflows – Start Session Recording only after the user opts in.
- Custom targeting – Pass JavaScript expression values into
run()for dynamic targeting. - Event-based targeting – Track events and use them in intercept targeting logic.
- XM Directory integration – Pass External Reference ID via
QSI.configto match visitors with XM Directory contacts for segment targeting and contact frequency.
Integration Guide
To successfully integrate the Web Feedback JavaScript APIs and start controlling intercepts programmatically, complete the following steps in sequence. Each step builds on the previous one.
Further Steps
Once you're comfortable with the basics, explore these guides:
- Pairing with Session Recording – Control DXA Session Recording for consent workflows and SPA navigation.
- Connecting with XM Directory – Pass External Reference ID for XM Directory targeting, contact frequency, and automatic contact creation.
- Try configuring App feedback via our Mobile SDKs for Android, iOS, React Native, and Flutter.
API Reference and Troubleshooting
For a complete reference of all classes and methods, see the API Reference.
If you encounter issues, refer to Troubleshooting, which works in conjunction with the API Reference.