Survey Guard API

Run survey quality checks from your own pipeline. Upload an SPSS file, choose the checks, submit a batch and collect the findings, all with one API key.

How a request moves through the API

Every integration follows the same five steps. Only the fourth one starts billable work.

  1. Create a keyPick an organization, permissions and an expiry.Account → API keys
  2. Upload a surveySend an SPSS .sav file straight to storage.POST /datasets/uploads
  3. Choose checksReview mappings, checks and AI settings.GET …/configuration
  4. Submit a batchRun up to 10 surveys in one request.POST /surveyguard/batches
  5. Read resultsPoll, then download flags, scores and evidence.GET /surveyguard/runs/{run_id}

Make your first call

With a key and a saved project, this request reads the project’s configuration. It is read-only and costs nothing. Set CM_API_BASE to your environment plus /api/customer/v1, as shown in API keys.

Read a project’s configuration
# Read-only: fetches a saved project's configuration. Starts nothing.
curl --fail-with-body "$CM_API_BASE/surveyguard/projects/$CM_PROJECT_ID/configuration" \
  -H "Authorization: Bearer $CM_API_KEY"

What to know before you build

Base path
/api/customer/v1 on the Crowdmines environment where you created the key. The API is not enabled on every environment.
Authentication
Authorization: Bearer YOUR_API_KEY on every API request, and never on storage upload or download links.
File format
SPSS .sav only. CSV, Excel and compressed .zsav files are rejected.
Limits
60 requests per minute per organization, shared across keys. 10 projects per batch. 1 MiB per JSON body.
Results
Polling only. Webhooks and automated clean-SPSS exports are not part of this release.
Costs
Submitting a batch uses your existing credits and quotas. AI-enabled checks can add AI charges.

Endpoints

Generated from the supported API contract. Select one for its parameters and schemas, or import the OpenAPI specification into your own tools.