Export Responses In JSON

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

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": [
        {
            "Respondent Unique Id": "61b77cb97f69a799bd3183c5",
            "Response Status": "Completed",
            "Language": "eng_us",
            "Collector Name": "Web Link 1",
            "Collector Unique Id": "61b77ca97f69a799bd3183c4",
            "Start Date": "2021-12-13 20:03:02",
            "End Date": "2021-12-13 20:05:47",
            "Time Duration": "2.73 m",
            "IP Address": "::1",
            "Device Information": "Desktop Chrome",
            "Survey Version": 1,
            "Custom Variables": {
                "Email Address": "",
                "First Name": "",
                "Last Name": "",
                "Mobile": "",
                "External Unique ID": ""
            },
            "location": {
                "Latitude": "",
                "Longitude": ""
            },
            "By Ticket": "",
            "Ticket(s) Generated": "",
            "Answers": [
                {
                    "Question Text": "What is your gender",
                    "Answer": [
                        {
                            "Value": "male"
                        }
                    ]
                },
                {
                    "Question Text": "Which product do you want",
                    "Answer": [
                        {
                            "Value": "Mobile"
                        },
                        {
                            "Value": "laptop"
                        },
                        {
                            "Value": "TV"
                        }
                    ]
                },
                {
                    "Question Text": "Would you recommend our product?",
                    "Answer": [
                        {
                            "Value": "10-Very Likely"
                        }
                    ]
                },
                {
                    "Question Text": "What is your age",
                    "Answer": [
                        {
                            "Value": "18+"
                        }
                    ]
                },
                {
                    "Question Text": "location",
                    "Answer": [
                        {
                            "Value": "india"
                        }
                    ]
                },
                {
                    "Question Text": "How satisfied are you with our products?",
                    "Answer": [
                        {
                            "Row Text": "Product Quality - Mobile",
                            "Value": "Good"
                        },
                        {
                            "Row Text": "Product Quality - TV",
                            "Value": "Bad"
                        },
                        {
                            "Row Text": "Support - Mobile",
                            "Value": "Average"
                        },
                        {
                            "Row Text": "Support - TV",
                            "Value": "Bad"
                        }
                    ]
                },
                {
                    "Question Text": "Enter your contact information",
                    "Answer": [
                        {
                            "Row Text": "Name",
                            "Value": "rahul pal"
                        },
                        {
                            "Row Text": "Company",
                            "Value": "Admin"
                        },
                        {
                            "Row Text": "Address 1",
                            "Value": "H-196"
                        },
                        {
                            "Row Text": "Address 2",
                            "Value": "Noida"
                        },
                        {
                            "Row Text": "City/Town",
                            "Value": "Noida"
                        }
                    ]
                },
            ]
        }
    ],
    "skip": 0,
    "limit": "30"
}

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"
  }
}