Convert API Documentation Overview

Convert Experience Serving API

The following endpoints are part of the Experience Serving API available at https://api.convert.com/doc/serving. This API allows fast, real-time delivery of experiences and tracking user interactions.

1. SDK Key Authentication

Details how to authenticate requests using SDK keys, which are lightweight identifiers used for secure client-side or backend access.

2. Debug Token

Explains how to use the convert-debug-token header to access draft or paused experiences for preview or QA purposes.

3. Project Config

Endpoints that deliver configuration data needed by the SDK or backend to determine which experiences to show and how.

4. Experiences Tracking

Allows tracking of events, goals, and visitor actions from SPAs or server-side environments in real time.

Convert REST API v2

Accessible via https://api.convert.com/doc/v2, this comprehensive REST API enables full lifecycle management of Convert projects, users, experiments, and results.

Authentication

• API Key Authentication: Token-based user-level authentication.

• Cookie Authentication: Used primarily for web-based session management.

Core Resources

• User: Manage user data, MFA, email confirmation, etc.

• Accounts: Retrieve account details and sub-account relationships.

• AI Content: Endpoints for AI-powered content features.

• Collaborators: Manage shared access and user collaboration.

• API Keys: Create and manage your API credentials.

• Projects: Create, update, and retrieve Convert projects.

• SDK Keys: Generate keys for SDK authentication.

Experiences & Experimentation

• Experiences: Main resource for creating and managing experiments.

• Experience Variations: Control variations in each experience.

• Experience Sections: Manage the modular structure of multi-page or dynamic tests.

• Section Versions: Access and modify versioned components.

• Version Changes: Track and manage changes across iterations.

• Experiences Reports: Pull reporting data programmatically.

Goals & Strategy

• Goals: Define and manage conversion goals.

• Hypotheses: Organize and document test ideas and strategies.

• Knowledge Bases: Structured documentation tied to projects.

• Observations: Record user behavior or test insights.

Targeting & Segmentation

• Locations: Define geographic or site-specific test targeting.

• Audiences: Configure custom audiences based on behavior or properties.

• Domains: Manage domain targeting for experiences.

• CDN Images: Upload and reference assets used in variations.

• Tags: Label and organize projects or experiences.

• Features: Manage feature flags or toggles for full-stack experimentation.

• Visitor Insights: Collect behavioral insights from users.

Next Steps

Developers are encouraged to use these API endpoints for:

• Automating experiment creation and reporting

• Integrating Convert into CI/CD pipelines

• Creating dashboards or tools for clients or internal teams

For Postman collections, SDKs, or setup help, see our article: Use the Convert API