Responses

Retrieve a paginated list of survey responses with answers.

Query Parameters

Example Request

curl -X GET "https://app.surventrics.ai/api/v1/surveys/SURVEY_ID/responses?status=completed&pageSize=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": "resp_550e8400-e29b-41d4-a716-446655440000",
      "sessionId": "sess_abc123",
      "status": "completed",
      "startedAt": "2024-01-20T10:30:00Z",
      "completedAt": "2024-01-20T10:35:00Z",
      "deviceType": "mobile",
      "country": "US",
      "answers": [
        {
          "questionId": "q_001",
          "questionTitle": "How satisfied are you?",
          "value": "Very Satisfied",
          "answeredAt": "2024-01-20T10:31:00Z"
        },
        {
          "questionId": "q_002",
          "questionTitle": "How likely are you to recommend us?",
          "value": 9,
          "answeredAt": "2024-01-20T10:32:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "total": 142,
    "page": 1,
    "pageSize": 50,
    "totalPages": 3,
    "hasMore": true
  }
}

Export all survey responses as CSV, JSON, Excel or an SPSS package. The SPSS package needs the Pro plan or above; the other formats need no plan beyond API access.

Query Parameters

Example: CSV Export

curl -X GET "https://app.surventrics.ai/api/v1/surveys/SURVEY_ID/responses/export?format=csv" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o responses.csv

CSV Output

The CSV includes metadata columns followed by one column per question, headed by the question's text. It is the same file the results page downloads:

Response ID,Started At,Completed At,Status,Duration (seconds),Device Type,Country,Quality Score,How satisfied are you?,How likely to recommend?
sess_abc,2024-01-20T10:30:00Z,2024-01-20T10:35:00Z,completed,300,mobile,US,0.95,Very Satisfied,9
sess_def,2024-01-20T11:00:00Z,2024-01-20T11:08:00Z,completed,480,desktop,UK,0.88,Satisfied,7

A text cell that begins with =, +, -, @, a tab or a carriage return is written with a leading apostrophe ('=1+1), so a spreadsheet shows it as text instead of running it as a formula. Numbers, negative ones included, are unchanged. Use format=json for the raw values.

Example: JSON Export

curl -X GET "https://app.surventrics.ai/api/v1/surveys/SURVEY_ID/responses/export?format=json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o responses.json

JSON Output

{
  "survey": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Customer Satisfaction Survey",
    "slug": "customer-satisfaction-2024"
  },
  "questions": [
    { "id": "q_001", "title": "How satisfied are you?", "type": "single_choice" },
    { "id": "q_002", "title": "How likely to recommend?", "type": "nps" }
  ],
  "responses": [
    {
      "response_id": "resp_001",
      "respondent_id": "sess_abc",
      "status": "completed",
      "started_at": "2024-01-20T10:30:00Z",
      "completed_at": "2024-01-20T10:35:00Z",
      "device_type": "mobile",
      "country": "US",
      "quality_score": 0.95,
      "q_001": "Very Satisfied",
      "q_002": 9
    }
  ],
  "exportedAt": "2024-01-21T09:00:00Z",
  "totalResponses": 142
}

Response Statuses

Answer Value Types

The value field type depends on the question type:

An answer to a question marked as personal data comes back as the string "[redacted]" when the member your API key acts as has an organization role that may not see it. The same applies to exports, probe transcripts and BI connector endpoints.