Get Responses (CSV format)

☰

POST: https://{{env}}.survey2connect.com/v2/api/surveys/{{surId}}/responses/csv

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.

Headers

"Content-Type": "application/json"

Authorization

type: Api Key  
Key: x-api-key 
token: value from portal

Request Parameters

Path Parameters

{{surId}}: Unique Survey ID

Request Body

Payload

{ 
    "timeFilter": { 
        "amount": 2, 
        "period":"days", 
        "type":"rolling" 
    }, 
    "status": ["1"], 
    "paginationDetails": { 
        "skip": 0, 
        "limit":100 
    } 
}

Supported Filters

Field	Type	Mandatory	Description
timeFilter	Object	No	Rolling Filter (e.g. Last 7 days, Last 3 months etc.) { amount:7, period:"days/months/years" type:"rolling" } Before/After Time filter (e.g. before Nov 1st 2020, After July 15th 2020) { operand: [“dd/mm/yyyy”] type: "before/after" } Relative Time Filter (e.g. Today, This Month, Last Month, Previous Year) { amount: 7, period: "day/week/month/year", type: "relative" } Between Time Filter (e.g. between July 15th 2020 & Nov 1st 2020) { operand:[“dd/mm/yyyy”,”dd/mm/yyyy”] type:"between" }
status	Array	No	Integer(0-2) 0 : Incomplete/Partial Responses 1: Complete Responses 2 : Disqualified Responses
collectorIds	Array	No	{ "skip": 0, "limit":100 }

Request Sample

cURL

curl --location --request POST 'https://az1.survey2connect.com/v2/api/surveys/6368975d8f142e56a6557ccb/responses/csv' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJraWQiOiJzM3E1OWF2cFdIcXVKa0I0MjRpcFpqQVN0dXAzQzFkZEhVM3k2TjNZSXRjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0MTIxMDc1NC01ODVkLTRjNmQtODc2NC02Mzg0NzJkYTRhODEiLCJ6b25laW5mbyI6InByb2RfYXoxIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImN1c3RvbTpwYXNzd29yZFRvQmVSZXNldCI6ImZhbHNlIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmFwLXNvdXRoLTEuYW1hem9uYXdzLmNvbVwvYXAtc291dGgtMV9zalNzc2JrOXYiLCJwaG9uZV9udW1iZXJfdmVyaWZpZWQiOmZhbHNlLCJjdXN0b206dUlkIjoiNjExYmEzNTcwZjdhNDEyNDYxM2MyMzg2IiwiY29nbml0bzp1c2VybmFtZSI6IjQxMjEwNzU0LTU4NWQtNGM2ZC04NzY0LTYzODQ3MmRhNGE4MSIsImF1ZCI6Ijg1azh1b2RqODBpazUzb2F0cDRycWJsYmMiLCJldmVudF9pZCI6IjE1NWYzNDA5LTkxOTQtNGIwOC05NzI1LTk1ZjEyOTViMGRjMSIsInRva2VuX3VzZSI6ImlkIiwiYXV0aF90aW1lIjoxNjY5MTgzOTQ3LCJjdXN0b206c3RhdHVzIjoiYWN0aXZlIiwibmFtZSI6IlRlc3QgRCIsInBob25lX251bWJlciI6Iis5MTc0MTc0NjExNzYiLCJleHAiOjE2NjkyNzAzNDcsImN1c3RvbTpyb2xlIjoiYnJhbmRBZG1pbiIsImlhdCI6MTY2OTE4Mzk0NywiZW1haWwiOiJkYXZpbmRlci5zQHN1cnZleTJjb25uZWN0LmNvbSJ9.TCnoiWVPKpMQq9ygME2y-arC653tbTu8Rpm6ziyWDjAhkfiEP42LiGYPAOHJrPb_G5AzGlbKeKeDhx7DCKKGb9ZVg36ltiCOH3KapscL2PB_6qeKDXZfGTDUjUqxVjsuFXeLVGRIUpmgEjQq3f8lnKLEBHPspwvbxZ7jcSuk9BAO2VDAtdPulmiYF7NhfBQ2xXdpYaJiJxJPkdz-vZfvofRITKTu8XgozT0IRTHJ5lP3yYLc9asDflYNs-np2g4bwn8St_lEOT6abhOpoH6DpHT1yNaP7w1zQ3U0lXCaZ4imGp7ETZ5kYpuRMuJ8bINUCZHyi8uQF-rZkv6Fk6-Gmg' \
--data-raw '{
"timeFilter": {
"amount": 2,
"period":"days",
"type":"rolling"
},
"status": ["1"],
"paginationDetails": {
"skip": 0,
"limit":100
}
} '

Javascript

var myHeaders = new Headers(); 
myHeaders.append("Authorization", "Bearer eyJraWQiOiJzM3E1OWF2cFdIcXVKa0I0MjRpcFpqQVN0dXAzQzFkZEhVM3k2TjNZSXRjPSIsImFs"); 
myHeaders.append("Content-Type", "application/json"); 
var raw = JSON.stringify({ 
  "timeFilter": { 
    "amount": 2, 
    "period": "days", 
    "type": "rolling" 
  }, 
  "status": [ 
    "1" 
  ], 
  "paginationDetails": { 
    "skip": 0, 
    "limit": 100 
  } 
}); 
var requestOptions = { 
  method: 'POST', 
  headers: myHeaders, 
  body: raw, 
  redirect: 'follow' 
}; 
fetch("https://az1.survey2connect.com/v2/api/surveys/63281de56d497d12b49199c1/responses/csv", requestOptions) 
  .then(response => response.text()) 
  .then(result => console.log(result)) 
  .catch(error => console.log('error', error));

Responses

200

{ 
    "data": [ 
        [ 
            "Respondent Unique Id", 
            "Response Status", 
            "Language", 
            "Collector Name", 
            "Collector Unique Id", 
            "Sent Date", 
            "Start Date", 
            "End Date", 
            "Time Duration", 
            "IP Address", 
            "Device Information", 
            "Survey Version", 
            "Email Address", 
            "First Name", 
            "Last Name", 
            "Mobile", 
            "External Unique ID", 
            "Location Latitude", 
            "Location Longitude", 
            "By Ticket", 
            "Ticket(s) Generated", 
            "verification_status", 
            "What is your gender ?", 
            "Please rate our service." 
        ], 
        [ 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "" 
        ], 
        [ 
            "633401ecb9fa677c7787da94", 
            "Completed", 
            "eng_us", 
            "Web Link 4", 
            "633401e145d42a3538db27e6", 
            "", 
            "2022-09-28 13:42:29", 
            "2022-09-28 13:42:32", 
            "0.08 m", 
            "15.206.198.203", 
            "Desktop Chrome", 
            2, 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "male", 
            "7" 
        ], 
        [ 
            "633401f45512747bbe0e197b", 
            "Completed", 
            "eng_us", 
            "Web Link 4", 
            "633401e145d42a3538db27e6", 
            "", 
            "2022-09-28 13:42:37", 
            "2022-09-28 13:42:39", 
            "0.06 m", 
            "15.206.198.203", 
            "Desktop Chrome", 
            2, 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "", 
            "female", 
            "9" 
        ] 
    ], 
    "skip": 0, 
    "limit": 100 
}

400

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

500

{   
    "error": {   
         "name": "Internal Server Error",   
         "message": "We were not able to process your request"   
    }   
}

POST: https://{{env}}.survey2connect.com/v2/api/surveys/{{surId}}/response-count The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Get Responses (JSON Format)

POST: https://{{env}}.survey2connect.com/v2/api/surveys/{{surId}}/responses/json The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Get Responses (SPSS format)

POST: https://{{env}}.survey2connect.com/v2/api/surveys/{{surId}}/responses/spss The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.…

Ask a human

API Center