> ## Documentation Index
> Fetch the complete documentation index at: https://docs.repdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Getting Started

> SightX API capabilities, core objects, and the end-to-end integration lifecycle.

*This page provides an overview of SightX API capabilities, integration steps, and helpful context for business stakeholders and developers.*

<Note>
  API access is a paid add-on. Contact [sales@sightx.io](mailto:sales@sightx.io) or your SightX account manager to enable access.
</Note>

***

## 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**.

| Detail               | Value                                                |
| -------------------- | ---------------------------------------------------- |
| API type             | RESTful (JSON; some endpoints return files)          |
| Authentication       | Signed JWT → access token (12-hour validity)         |
| Authorization header | `Authorization: <access_token>` (no `Bearer` prefix) |
| HTTP methods         | GET, POST, PUT, PATCH, DELETE                        |

See [Environments & Status Codes](/sightx/overview/02-environments-and-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](/sightx/overview/00-platform-overview) for full context.

| Object                    | API role                                                         |
| ------------------------- | ---------------------------------------------------------------- |
| Project                   | Create, clone, move, and organize research initiatives           |
| Survey                    | Build question content, apply logic, manage translations         |
| Campaign                  | Launch distribution waves with links, quotas, and send schedules |
| Audience / recipient list | Manage contact groups for email/SMS distribution                 |
| Response                  | Capture, filter, clean, export, and restore respondent data      |
| Analysis                  | Run dashboards, comparisons, personas, and advanced stats        |

***

## 3. High-level integration flow

A typical SightX API integration follows this lifecycle.

<Steps>
  <Step title="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](/sightx/guides/01-authentication-flow) · [Generate Keys](/sightx/guides/02-generate-keys)
  </Step>

  <Step title="Create or retrieve a project">
    Create a project (or retrieve an existing one) to hold your survey, campaigns, and responses.

    Go to: [List Projects](/sightx/endpoints/get-projects-api-v2-projects) · [Create Project](/sightx/endpoints/post-projects-api-v2-folders-folderid-projects)
  </Step>

  <Step title="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](/sightx/endpoints/get-projects-api-v1-projects-projectid) · [Save Translations](/sightx/endpoints/post-projects-api-v1-translations-bulkupsert)
  </Step>

  <Step title="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](/sightx/endpoints/post-campaigns-service-v1-campaigns) · [Send Campaign](/sightx/endpoints/post-campaigns-service-v1-campaigns-campaignid-send)
  </Step>

  <Step title="Capture responses">
    As respondents complete surveys, retrieve response data, monitor stats, and manage the cleaning workflow.

    Go to: [Response Stats](/sightx/endpoints/get-responses-capture-service-v1-responses-stats) · [Filter Responses](/sightx/endpoints/post-responses-capture-service-v1-responses-responseswithfilter)
  </Step>

  <Step title="Analyze and export">
    Run analysis dashboards, compare segments, and export data for downstream reporting.

    Go to: [Export Responses](/sightx/endpoints/post-api-export) · [Question Analysis](/sightx/endpoints/post-multiple-question-analysis-service-analysis)
  </Step>
</Steps>

***

## 4. Platform-to-API mapping

| Platform module    | What you do in the UI                          | What the API enables                                        |
| ------------------ | ---------------------------------------------- | ----------------------------------------------------------- |
| Build              | Add questions, logic, design, languages        | Programmatic survey updates, translations, question library |
| Distribution       | Create campaigns, set quotas, send invitations | Campaign lifecycle, recipient management, quota monitoring  |
| Survey             | Respondents take the survey                    | Render and capture endpoints for custom respondent flows    |
| Responses          | Review, clean, and export data                 | Response retrieval, cleaning system, multi-format export    |
| Analysis           | Dashboards, personas, text analysis            | Analysis microservice endpoints per question type           |
| Projects Dashboard | Organize projects in folders                   | Project CRUD, clone, move, folder management                |
| Audiences          | Manage contact lists                           | Audience and recipient list CRUD, datasheet upload          |

<Tip>
  The [SightX Knowledge Base](https://support.sightx.io/knowledge) has detailed UI guides for each module. Use it alongside this API reference to understand platform behavior behind each endpoint.
</Tip>

***

## 5. Next steps

<CardGroup cols={2}>
  <Card title="Authentication Flow" icon="lock" href="/sightx/guides/01-authentication-flow">
    JWT signing, token exchange, and code examples.
  </Card>

  <Card title="Environments" icon="server" href="/sightx/overview/02-environments-and-status-codes">
    Staging vs. production service URLs.
  </Card>

  <Card title="API Reference" icon="code" href="/sightx/endpoints/post-v1-m2m-token">
    Browse all endpoints with a live playground.
  </Card>
</CardGroup>