Skip to main content
This page provides an overview of SightX API capabilities, integration steps, and helpful context for business stakeholders and developers.
API access is a paid add-on. Contact sales@sightx.io or your SightX account manager to enable access.

​
1. What is the SightX API?

The SightX API is a RESTful interface that lets your systems interact directly with the SightX platform — building surveys, managing campaigns and audiences, capturing responses, and running analysis — without manual work in the SightX UI. This is most valuable for organizations that want to:
  • Automate survey creation and project management at scale
  • Integrate SightX into internal platforms or research operations tools
  • Sync project, campaign, and response data with their own systems in real time
  • Trigger distribution, exports, and analysis programmatically
The API is organized to mirror the SightX platform modules: Build, Distribution, Survey, Responses, Analysis, Projects Dashboard, and Audiences/Recipient lists. See Environments & Status Codes for staging and production service URLs.

​
2. Core concepts

Before integrating, it helps to understand how SightX structures work. See the Platform Overview for full context.

​
3. High-level integration flow

A typical SightX API integration follows this lifecycle.
1

Set up authentication

Generate an RSA key pair, upload your public key to SightX, and receive a client ID. Use your private key to sign JWTs and exchange them for access tokens.Go to: Authentication Flow · Generate Keys
2

Create or retrieve a project

Create a project (or retrieve an existing one) to hold your survey, campaigns, and responses.Go to: List Projects · Create Project
3

Build the survey

Configure survey content — questions, logic, design, and translations. The Build module endpoints handle project updates, translations, and question library management.Go to: Get Project · Save Translations
4

Set up distribution

Create a campaign, configure quotas, and obtain survey links. Launch the campaign when ready to collect live responses.Go to: Create Campaign · Send Campaign
5

Capture responses

As respondents complete surveys, retrieve response data, monitor stats, and manage the cleaning workflow.Go to: Response Stats · Filter Responses
6

Analyze and export

Run analysis dashboards, compare segments, and export data for downstream reporting.Go to: Export Responses · Question Analysis

​
4. Platform-to-API mapping

The SightX Knowledge Base has detailed UI guides for each module. Use it alongside this API reference to understand platform behavior behind each endpoint.

​
5. Next steps

Authentication Flow

JWT signing, token exchange, and code examples.

Environments

Staging vs. production service URLs.

API Reference

Browse all endpoints with a live playground.