Export Responses In SPSS

Once the responses are collected into the survey2connect platform, be it from SMS, Email or any other channel, the data can be exported back using our RESTFul APIs

POST https://{env}.survey2connect.com/v2/api/surveys/{sur_id}/responses/spss

Path Parameters

Name	Type	Description
env*	String	Datacenter identifier for client
sur_id*	String	id of the survey

Query Parameters

Name	Type	Description
skip	Number	Number of records to be skipped.
limit	Number	Total Number of records to be retrieved

Headers

Name	Type	Description
Authorization	String	Bearer {access_token}

Request Body

Name	Type	Description
responseIds	Array	List of ids of responses to be exported.
status	Array	Status of responses to be exported.
labels	String	Decides whether the value will be recoded value or the actual value
dateFilter	String	Filter for date
collectorIds	Array	Ids of the collectors

200: OK

{
  "data": {
    "varName": [
      "RespondentID",
      "ResponseStatus",
      "Language",
      "CollectorNm",
      "CollectorID",
      "StartDate",
      "EndDate",
      "TimeDuration",
      "IPAddress",
      "Device",
      "SurveyVersion",
      "EmailAddress",
      "FirstName",
      "LastName",
      "Mobile",
      "ExternalUniqueID",
      "Latitude",
      "Longitude",
      "ByTicket",
      "Tickets",
      "city",
      "Q1_R1",
      "Q2_R1"
    ],
    "varTypes": {
      "CollectorNm": 750,
      "RespondentID": 30,
      "ResponseStatus": 30,
      "Language": 50,
      "CollectorID": 30,
      "StartDate": 50,
      "EndDate": 50,
      "TimeDuration": 30,
      "IPAddress": 100,
      "Device": 50,
      "SurveyVersion": 50,
      "EmailAddress": 50,
      "FirstName": 50,
      "LastName": 50,
      "Mobile": 100,
      "ExternalUniqueID": 50,
      "Latitude": 50,
      "Longitude": 50,
      "ByTicket": 50,
      "Tickets": 50,
      "Q1_R1": 0,
      "Q2_R1": 0,
      "city": 50
    },
    "valLabels": {},
    "varLabels": {
      "CollectorNm": "Collector Name",
      "RespondentID": "Respondent Unique Id",
      "ResponseStatus": "Response Status",
      "Language": "Language",
      "CollectorID": "Collector Unique Id",
      "StartDate": "Start Date",
      "EndDate": "End Date",
      "TimeDuration": "Time Duration",
      "IPAddress": "IP Address",
      "Device": "Device Information",
      "SurveyVersion": "Survey Version",
      "EmailAddress": "Email Address",
      "FirstName": "First Name",
      "LastName": "Last Name",
      "Mobile": "Mobile",
      "ExternalUniqueID": "External Unique ID",
      "Latitude": "Location Latitude",
      "Longitude": "Location Longitude",
      "ByTicket": "By Ticket",
      "Tickets": "Ticket(s) Generated",
      "Q1_R1": "How was your overall experience?",
      "Q2_R1": "Hi {{e://Name}}Based on your experience, how likely are you to recommend our product to friends/family?",
      "city": "city"
    },
    "records": [
      [
        "6125d78482c0665cd04fb3c1",
        "Completed",
        "eng_us",
        "Web Link 1",
        "6125d759ad340a5c8f9ff31d",
        "2021-08-25 11:09:16",
        "2021-08-25 11:09:21",
        "0.07 m",
        "124.66.169.123",
        "Desktop Chrome",
        1,
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        2,
        3
      ],
      [
        "612c614a422b8833cf47c4fa",
        "Completed",
        "eng_us",
        "API Collector 1",
        "612b87ec422b8833cf4775a2",
        "2021-08-30 10:10:42",
        "2021-08-30 10:10:52",
        "0.15 m",
        "124.66.169.123",
        "Desktop Chrome",
        1,
        "[e-mail]",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "Pune",
        8,
        10
      ]
    ]
  }
}

400: Bad Request

{
  "error": {
    "name": "bad request",
    "message": "Invalid URL parameters (surveyId)"
  }
}

401: Unauthorized

{
  "error": {
    "name": "unauthorized",
    "message": "The authorization token was not provided"
  }
}

403: Forbidden

{
  "error": {
    "name": "forbidden",
    "message": "The user does not have permission to access the resource."
  }
}

500: Internal Server Error

{
  "error": {
    "name": "internal server error",
    "message": "We couldn’t process your request"
  }
}