Qualified API Overview

This guide provides an overview of the two primary APIs Qualified offers: the Server-side Reporting API for backend data integration and the Client-side JavaScript API for controlling the real-time visitor experience. Understanding the purpose of each is the first step in extending the power of the Qualified platform.

Server-side Reporting & Utility API

The Server-side API is designed for backend processes, allowing you to integrate Qualified data with your internal systems like a data warehouse or Business Intelligence (BI) tool. It's ideal for custom reporting, large-scale data analysis, and automating data management workflows.

Available Endpoints

• Enterprise Reporting (Bot Conversations, Rep Conversations): For customers on eligible plans, these endpoints provide a firehose of conversation data. This is perfect for building custom dashboards and analyzing every interaction Piper the AI SDR and your sales reps have with visitors.

• Utility (GDPR Deletion Requests, Cancel Meeting): Available to all customers upon request, these endpoints allow you to automate specific processes, like managing data privacy compliance or syncing meeting cancellations with other systems.

How to Get Started with the Server-side API

1. Identify Your Goal: Determine if you need to build a custom report, sync data, or automate a backend process.

2. Request Endpoint Access: Reach out to your dedicated Qualified Success Architect to discuss your use case and request activation for the specific server-side endpoints you need.

3. Generate Your API Key: Once your QSA has confirmed access is enabled, generate your API key by following the instructions in our guide: How to Generate a Qualified API Key.

4. Consult the Technical Documentation: With your key and enabled endpoint, your development team can use the official Qualified API Documentation for detailed specifications and code examples.

Client-side JavaScript API

The Client-side API is a set of JavaScript commands that you add directly to your website's code. It gives you real-time control over the Qualified messenger for each individual visitor, allowing you to create a highly personalized and dynamic experience.

Key Capabilities

• Identify Visitors: Pass data you already have about a visitor (like their name or email from your marketing automation platform) into Qualified using the identify call to personalize their experience.

• Handle Events: Trigger your own custom scripts or send data to another system when a visitor performs an action in the messenger, like starting a chat or booking a meeting, using the handleEvents function.

• Control the Messenger: Programmatically open the messenger, show specific experiences, or adapt to navigation on a single-page application (SPA) using commands like open, showExperience, and page.

• Retrieve Visitor Data: Pull information that Qualified has captured about a visitor during their session into other on-page tools (like a support chat) using the getIdentity function.

How to Get Started with the Client-side API

For a complete list of functions, implementation instructions, and detailed code samples, please refer to our comprehensive guide: Getting Started with the Client-side API.

Using the right API for the job enables deeper customization of the Qualified platform to better support your company's pipeline generation strategy. For further questions, please consult the resources and peers available in the Qualified University community.