×
Request a Demo

Request a Demo

Look No Further. Get Started Today

 
 

Verification

Survey Management
Location Management
User Management
Device Management

GetResponses

This API will enable you to get list of all responses related to a company. Depending on the scope of the account whose authentication is used with this API, the responses will be based on the Surveys linked to Locations assigned to this account.

Base URL : https://app.zonkafeedback.com/api/v1/responses

Parameters

Parameter Value Description
surveyId string ID of the survey to get responses for
locationId string ID of the location to get responses for
startDate datetime Date from which responses are to be fetched
endDate datetime Date till which responeses are to be fetched
respondentType string Type of Respondent for which responses are to be fetched. Select from ALL, NEW or REPEAT
comments string Fetch responses filtered as comments
todo string Fetch responses filtered as todo
urgent string Fetch responses filtered as urgent
flagged string Fetch responses filtered as flagged
notes string Fetch responses filtered as notes
defaultTags string Type of Respondent for which responses are to be fetched. Select from ALL, NEW or REPEAT
customTags string Fetch responses by custom defined tags.
page string Fetch responses by particular page number. 25 responses are fetched per page.
limit string Specify the number of responses to fetch per page. 25 responses per page is default.
staffId string Fetch list of responses by the Staff ID who took the responses
respondentId string Fetch list of responses by the Respondent ID who submitted the responses
responseStatus string Fetch list by response read status. Select from ALL, READ and UNREAD

Response Format

{
    "CurrentRecords": 25,
    "TotalRecords": 172,
    "TotalUnreadRecords": "144",
    "ResponseList": [
        {
            "LanguageCode": "en_US",
            "DateOfVisit": "2017-06-12 03:40:57",
            "DateOfVisitGMT": "2017-06-12 07:40:57",
            "CountDueTasks": "1",
            "CountEmailSent": "0",
            "CountNotesAdded": "0",
            "StaffName": "ExampleStaffName",
            "IsRatingFiledId": "15437",
            "DeviceName": "iphone6plus",
            "DeviceFriendlyName": "ExampleDevice",
            "DefaultTags": "Negative",
            "CustomTags": "Cleanliness",
            "RespondentVisitID": "3445",
            "RespondentID": "2855",
            "SurveyID": "1308",
            "CompanyID": "35",
            "CompanyLocationName": "CompanyName- LocationName",
            "LocationID": "106",
            "RespondentName": "ExampleRespondentName",
            "RespondentEmail": "tony@example.com",
            "RespondentMobile": "1234567890",
            "RespondentComments": "Nice Ambience",
            "IsResponseRead": "0",
            "IsResponseResolved": "0",
            "IsResponseUrgent": "0",
            "IsResponseFlagged": "0",
            "IsResponseArchived": "0",
            "ResponseStartTime": "2017-06-12 03:40:49",
            "ResponseStartTimeGMT": "2017-06-12 07:40:49",
            "ResponseFillTime": "2017-06-12 03:40:50",
            "ResponseFillTimeGMT": "2017-06-12 07:40:50",
            "SurveyTitle": "My First Survey",
            "SurveyTagID": "1",
            "StaffID": "59",
            "NPSFieldID": "12342",
            "NPSChoiceID": "12321",
            "NPSChoiceName": "10",
            "CESFieldID": "45367",
            "CESChoiceID": "56372",
            "CESChoiceName": "High",
            "Rating": "25.00",
            "ResponseDetails": [
                {
                    "QuestionId": "15434",
                    "QuestionLabel": "MCQ Question",
                    "Answer": "Button",
                    "ChoiceId": "44103",
                    "OptionId": ""
                },
                {
                    "QuestionId": "15435",
                    "QuestionLabel": "Mobile Number",
                    "Answer": "",
                    "ChoiceId": "",
                    "OptionId": ""
                },
                {
                    "QuestionId": "15436",
                    "QuestionLabel": "Last Name",
                    "Answer": "",
                    "ChoiceId": "",
                    "OptionId": ""
                },
                {
                    "QuestionId": "15437",
                    "QuestionLabel": "Radio Rating Label",
                    "Answer": "Option->Choice 3",
                    "ChoiceId": "44107",
                    "OptionId": "8290"
                }
            ]
        },
add-icon